Faraday: 기능 요청: HTTP 동사에 대한 명시적 메서드 정의

안녕하세요 @dduugg , 메서드를 명시적으로 정의하는 대신 문서 친화적인 솔루션을 탐색하겠습니다.
연결에서도 메타 프로그래밍 정의를 사용합니다. https://github.com/lostisland/faraday/blob/master/lib/faraday/connection.rb#L195

위에서 언급한 포인트와 잘 어울리나요?
그렇다면 Faraday 모듈에 대해서도 유사한 문서 스니펫을 복제할 수 있습니다.

@iMacTia 안녕하세요, 답변 감사합니다. 문서로 문제를 해결할 수 있다고 생각하지 않습니다. 명시적 정의에 대한 저항에 대해 자세히 설명해 주시겠습니까? 나는 그것이 토론의 틀을 잡는 것이 더 낫다고 생각합니다. 예를 들어, 문서 접근 방식은 7개의 한 줄 명시적 전달 정의보다 장황할 가능성이 높습니다( method_missing 코드 외에도 다양한 @!method 및 @!scope 지시문 포함). Faraday 에 제안합니다. 그러나 그것이 여기에 있는 근거인지는 모르겠습니다.

이번 변경으로 저를 경계하게 된 점은 주로 2가지입니다.

• 개인적으로 delegates 를 사용하는 것이 코드 작성자에게만 유리하다고 생각하지 않습니다. 저는 몇 년 동안 Ruby를 사용해 왔으며 다른 사람들과 마찬가지로 이 언어의 간결한 구문에 감사하게 되었습니다. 일부 코드를 읽고 delegates 찾으면 그것이 무엇을 의미하는지 즉시 알 수 있으며 잠재적으로 수십 줄의 코드를 몇 줄로 압축할 수 있습니다.
• HTTP 동사 프록시는 우리가 메타프로그래밍을 활용하는 패러데이의 유일한 인스턴스가 아닙니다. 더 많은 인스턴스가 있습니다. 여기에서 제기한 것과 동일한 문제로 고통을 겪을 가능성이 높지만 아직 발견되지 않았습니다. 이 변경에 동의하면 예외를 만들거나 선례를 만들 수 있습니다. 두 가지 모두 피하고 싶습니다.

그러나 이 변화에 대한 나의 저항에 초점을 맞추는 대신, 우리가 여기에서 소개하려고 하는 어떤 종류의 이점에 대해 논의하고 싶습니다. 나는 당신이 설명하는 문제를 완전히 이해했으며 실제로 가능한 경우 해결하려고 노력해야 한다고 생각합니다!
따라서 여기서 주요 문제가 코드 제안, 자동 완성 및 문서화를 위한 IDE/도구와의 호환성이라면 나는 단순히 문서 주석(우리는 이미 YARD를 상당히 광범위하게 사용하고 있음)과 같은 대체 솔루션을 찾는 것을 제안하고 있습니다.
또한 주석이 메서드 목록만큼 가독성에 영향을 미치지 않고 쉽게 알아볼 수 있다고 주장하지만 이 솔루션이 장황하다고 말할 때도 맞습니다.

안녕하세요 @iMacTia , 답변 감사합니다. API 검색 가능성 및 도구 지원이 더 나은 다른 라이브러리로 전환했지만 유용하다고 생각되는 경우에 대비하여 제 생각을 공유하겠습니다.

• 발견 가능성이 메타프로그래밍의 사용을 배제하지는 않지만(이 특정한 경우에는 명시적인 def 가 필요하다고 생각합니다), 앞에서 설명한 대로 method_missing 접근 방식을 대체해야 합니다.
• delegates 인수를 이해했는지 잘 모르겠습니다. Faraday는 HTTP 동사 메서드를 처리할 때 명시적 위임자를 사용하지 않는 것 같습니다. (이 점에 대한 혼동은 아마도 HTTP 동사 메서드의 구현이 지나치게 복잡하다는 코드 냄새일 것입니다.)
• delegate 등이 코드 작성자에게 도움이 된다는 데 동의해야 합니다. 나는 수십 년의 집단 루비 경험을 가진 사람들과 함께 일하고 있으며 여기에서 접근 방식에 대한 가독성 이점을 찾지 못했습니다(pry, YARD, sorbet 및 solargraph를 통해 API를 탐색하려고 시도하는 데 낭비되는 시간을 제외하더라도). ). 적어도 이 특정 지점에서 Rubyist가 이 API를 처음으로 탐색하는 것을 지켜보는 것이 좋습니다.

여기에 정직한(그리고 희망적으로 유용한) 피드백을 제공하려고 합니다. 나는 여전히 OSS에 대한 이 공헌에 대한 시간과 노력에 감사드립니다.

헤이, 패러데이에 대한 모든 수고에 감사드립니다! 나는 이것이 오래된 문제라는 것을 알고 있지만 검색 가능성이 약간의 문제라는 데 동의하는 경향이 있습니다. 저는 일부 미들웨어에서 작업 중이며 이 섹션을 README에 추가했습니다. 내 라이브러리는 이전에 Faraday를 사용해 본 적이 없는 사람을 대상으로 하므로 설명하는 것은 내가 해야 할 일입니다. 나는 (다소 머뭇거리며) 수수께끼를 푸는 것이 쉽지 않았다고 말할 것이다.

@gurgeous 나는 문서가 확실히 우리가 더 나은 일을 할 수 있는 최전선에 있다는 데 동의하지만(우리는 Faraday 웹 사이트 를 시작하여 이 문제를 해결하기 시작했지만) 이 문제의 제안이 귀하의 특정 요점을 어떻게 해결할지 모르겠습니다.

단순히 다른 방식으로 작업하는 데 익숙하기 때문에 요점을 놓치고 있는 것일 수도 있지만 라이브러리를 사용하는 방법을 모르는 경우 자동 완성 및 추측에 의존하지 않고 무엇을 해야 하는지 알 수 있습니다.
대신 라이브러리 문서를 확인하고 도움이 되지 않으면 코드를 자세히 살펴보고 작동 방식을 확인합니다.

따라서 개선된 문서(시각적 또는 코드 내)가 이 문제를 해결하는 방법이라고 생각하는 이유입니다.
그러나 여기에 더 나은 문서가 도움이되지 않는 특정 사용 사례 또는 여기에 누락 된 것이 있습니까?
"발견 가능성"에 대한 나의 이해가 올바른가요?

"발견 가능성"에 대한 나의 이해가 올바른가요?

제 경우는 아닙니다. 내 기대는 ls Faraday 에서 pry , 다음에 $ Faraday.get , 등등을 할 수 있는 것이었습니다. 특정 방법으로 뛰어들고 싶다면. 내가 사용한 다른 보석으로 이 작업을 효과적으로 수행할 수 있었다고 생각합니다. 문서 페이지로 이동할 필요가 거의 없기 때문에 이 티켓을 여는 경우가 거의 없습니다. (이는 라이브러리를 사용하는 코드를 인식하지 못하는 정적 분석 도구와 같이 위에서 언급한 다른 문제에 추가됩니다.)

소리를 들어주셔서 다시 한 번 감사드립니다.

저는 패러데이 웹사이트를 좋아합니다! 몇 가지 제안과 함께 PR을 제출할 수 있습니까? 도와주셔서 기쁩니다. 그런 노력은 항상 새내기들에게 보상을 주는 것 같아요. 관심이 있으시면 알려주세요.

pry + ls Faraday 에서 나도 그 패턴의 팬이며 광범위하게 사용합니다. method_missing에서 멀어지는 것은 나쁜 생각이 아닙니다. Ruby는 Ruby 3, 언어 서버, RBS 등의 등장으로 천천히 그 방향으로 끌려가고 있습니다. 하지만 이것은 문서에 부차적이라고 생각합니다.

@gurgeous 우리는 Pull Requests 문서에 관심이 _있습니다_. 웹사이트를 GitHub Pages에 게시하는 데 사용되는 Gemfile(및 README) 세트가 있는 docs/ 디렉토리를 찾습니다. 사용법이 불명확하거나 웹사이트 업데이트 과정에서 _that_에 대한 이슈나 PR도 열어주세요.

Faraday 사용자를 배려해주셔서 감사합니다!

저는 패러데이 웹사이트를 좋아합니다! 몇 가지 제안과 함께 PR을 제출할 수 있습니까? 도와주셔서 기쁩니다. 그런 노력은 항상 새내기들에게 보상을 주는 것 같아요. 관심이 있으시면 알려주세요.

@gurgeous 절대적으로! 우리는 항상 문서나 웹사이트 개선에 대한 도움을 환영합니다. 우리 유지 관리자에게 분명한 것이 사용자에게는 분명하지 않을 수 있기 때문입니다. 게다가 우리는 시간과 함께 정말 고군분투하며 종종 문서화 비용이 발생합니다. 사실 @olleolleolle의 지속적인 노력이 없었다면

pry 포인트(cc @dduugg)에서 나는 그것을 사용하지 않았으므로 아마도 이해하지 못했을 것입니다.
방금 귀하의 추가 세부 정보로 시도해 보았고 ls Faraday::Connection 는 동적으로 생성된 메서드와 위임된 메서드를 보여줍니다 🙌.
따라서 이러한 종류의 Ruby "마법"을 사용할 수 없다는 나의 원래 이해는 잘못되었으며 실제로 유일한 제한은 missing_method 입니다.

내가 별로 좋아하지 않는 것은 다음과 같은 명시적 방법의 도입이었습니다.

def self.get(...)
  ...
end

def self.post(...)
  ...
end

# ... and so on ...

그러나 기본 Faraday 모듈에 동적 정의 또는 위임을 추가하여 pry 의 검색을 수정할 수 있다면 그건 괜찮습니다. 먼저 못받아서 죄송합니다!

시간 제약에 대한 걱정이 없습니다. 오픈 소스 유지 관리자가 되는 것을 결코 나쁘게 생각하지 마십시오! 귀하의 노력에 감사드립니다. 나도 가봤어...

나는 우리가 같은 페이지에 있는지 확인하기 위해 re:docs에 대한 토론을 시작할 것입니다.

@iMacTia 사용자가 Faraday::Connection 를 살펴보는 방법을 알 수 있습니까? 그 이후로 검색 가능한 API가 있는 HTTP gem으로 전환했지만 https://lostisland.github.io/faraday/usage/를 간략히 살펴보았고 코드 예제 중 어느 것도 명시적으로 사용하지 않았습니다(마지막은 그렇게 하지만 암시적으로). 예제는 주로 Faraday 에서 정적 메서드를 호출하지만 pry에서는 찾을 수 없습니다. 나는 이 접근 방식을 취한 다른 보석을 알지 못하며 여전히 그것이 반패턴이라는 견해를 가지고 있습니다.

언제나처럼, 제 말을 들어주셔서 감사합니다.