ruboty-rurema 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: e8e3e12d8a36e5dc4f5aa2a6c1b1a7b5dbbece4db23474f346f40a31aa168cb2
+  data.tar.gz: a793d127cf88ca99c59b9915cdbfe44911b6c37b429a055e69b3a5cb25522fa1
+SHA512:
+  metadata.gz: ff25b0cd3514ef6f241abf3eac99e070dbd2985f99c3b76e3a19d0e081b722e51decb5956c4b8b7d2464c7e993b82a69ade34d3bf0fc74eefddf18005c7a8576
+  data.tar.gz: fe3993adb4a312165495a02bfcaf091d1d3ee77ee94eaac21f860a2dd17c578eadc4bf1c5d8aedf5a6e28b2c8b7f1cf69d75b3ead323c9748fccde1e311a467d

data/.gitignore

@@ -0,0 +1,9 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+/Gemfile.lock

data/Gemfile

@@ -0,0 +1,6 @@
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in ruboty-rurema.gemspec
+gemspec
+
+gem "rake", "~> 12.0"

data/LICENSE

@@ -0,0 +1,116 @@
+CC0 1.0 Universal
+
+Statement of Purpose
+
+The laws of most jurisdictions throughout the world automatically confer
+exclusive Copyright and Related Rights (defined below) upon the creator and
+subsequent owner(s) (each and all, an "owner") of an original work of
+authorship and/or a database (each, a "Work").
+
+Certain owners wish to permanently relinquish those rights to a Work for the
+purpose of contributing to a commons of creative, cultural and scientific
+works ("Commons") that the public can reliably and without fear of later
+claims of infringement build upon, modify, incorporate in other works, reuse
+and redistribute as freely as possible in any form whatsoever and for any
+purposes, including without limitation commercial purposes. These owners may
+contribute to the Commons to promote the ideal of a free culture and the
+further production of creative, cultural and scientific works, or to gain
+reputation or greater distribution for their Work in part through the use and
+efforts of others.
+
+For these and/or other purposes and motivations, and without any expectation
+of additional consideration or compensation, the person associating CC0 with a
+Work (the "Affirmer"), to the extent that he or she is an owner of Copyright
+and Related Rights in the Work, voluntarily elects to apply CC0 to the Work
+and publicly distribute the Work under its terms, with knowledge of his or her
+Copyright and Related Rights in the Work and the meaning and intended legal
+effect of CC0 on those rights.
+
+1. Copyright and Related Rights. A Work made available under CC0 may be
+protected by copyright and related or neighboring rights ("Copyright and
+Related Rights"). Copyright and Related Rights include, but are not limited
+to, the following:
+
+  i. the right to reproduce, adapt, distribute, perform, display, communicate,
+  and translate a Work;
+
+  ii. moral rights retained by the original author(s) and/or performer(s);
+
+  iii. publicity and privacy rights pertaining to a person's image or likeness
+  depicted in a Work;
+
+  iv. rights protecting against unfair competition in regards to a Work,
+  subject to the limitations in paragraph 4(a), below;
+
+  v. rights protecting the extraction, dissemination, use and reuse of data in
+  a Work;
+
+  vi. database rights (such as those arising under Directive 96/9/EC of the
+  European Parliament and of the Council of 11 March 1996 on the legal
+  protection of databases, and under any national implementation thereof,
+  including any amended or successor version of such directive); and
+
+  vii. other similar, equivalent or corresponding rights throughout the world
+  based on applicable law or treaty, and any national implementations thereof.
+
+2. Waiver. To the greatest extent permitted by, but not in contravention of,
+applicable law, Affirmer hereby overtly, fully, permanently, irrevocably and
+unconditionally waives, abandons, and surrenders all of Affirmer's Copyright
+and Related Rights and associated claims and causes of action, whether now
+known or unknown (including existing as well as future claims and causes of
+action), in the Work (i) in all territories worldwide, (ii) for the maximum
+duration provided by applicable law or treaty (including future time
+extensions), (iii) in any current or future medium and for any number of
+copies, and (iv) for any purpose whatsoever, including without limitation
+commercial, advertising or promotional purposes (the "Waiver"). Affirmer makes
+the Waiver for the benefit of each member of the public at large and to the
+detriment of Affirmer's heirs and successors, fully intending that such Waiver
+shall not be subject to revocation, rescission, cancellation, termination, or
+any other legal or equitable action to disrupt the quiet enjoyment of the Work
+by the public as contemplated by Affirmer's express Statement of Purpose.
+
+3. Public License Fallback. Should any part of the Waiver for any reason be
+judged legally invalid or ineffective under applicable law, then the Waiver
+shall be preserved to the maximum extent permitted taking into account
+Affirmer's express Statement of Purpose. In addition, to the extent the Waiver
+is so judged Affirmer hereby grants to each affected person a royalty-free,
+non transferable, non sublicensable, non exclusive, irrevocable and
+unconditional license to exercise Affirmer's Copyright and Related Rights in
+the Work (i) in all territories worldwide, (ii) for the maximum duration
+provided by applicable law or treaty (including future time extensions), (iii)
+in any current or future medium and for any number of copies, and (iv) for any
+purpose whatsoever, including without limitation commercial, advertising or
+promotional purposes (the "License"). The License shall be deemed effective as
+of the date CC0 was applied by Affirmer to the Work. Should any part of the
+License for any reason be judged legally invalid or ineffective under
+applicable law, such partial invalidity or ineffectiveness shall not
+invalidate the remainder of the License, and in such case Affirmer hereby
+affirms that he or she will not (i) exercise any of his or her remaining
+Copyright and Related Rights in the Work or (ii) assert any associated claims
+and causes of action with respect to the Work, in either case contrary to
+Affirmer's express Statement of Purpose.
+
+4. Limitations and Disclaimers.
+
+  a. No trademark or patent rights held by Affirmer are waived, abandoned,
+  surrendered, licensed or otherwise affected by this document.
+
+  b. Affirmer offers the Work as-is and makes no representations or warranties
+  of any kind concerning the Work, express, implied, statutory or otherwise,
+  including without limitation warranties of title, merchantability, fitness
+  for a particular purpose, non infringement, or the absence of latent or
+  other defects, accuracy, or the present or absence of errors, whether or not
+  discoverable, all to the greatest extent permissible under applicable law.
+
+  c. Affirmer disclaims responsibility for clearing rights of other persons
+  that may apply to the Work or any use thereof, including without limitation
+  any person's Copyright and Related Rights in the Work. Further, Affirmer
+  disclaims responsibility for obtaining any necessary consents, permissions
+  or other rights required for any use of the Work.
+
+  d. Affirmer understands and acknowledges that Creative Commons is not a
+  party to this document and has no duty or obligation with respect to this
+  CC0 or use of the Work.
+
+For more information, please see
+<http://creativecommons.org/publicdomain/zero/1.0/>

data/README.md

@@ -0,0 +1,65 @@
+# Ruboty::Rurema
+
+Search the Ruby Reference Manual via Ruboty.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'ruboty-rurema'
+```
+
+And then execute:
+
+    $ bundle install
+
+Or install it yourself as:
+
+    $ gem install ruboty-rurema
+
+## Usage
+
+Ruboty is aware of `Klass`, `Klass#method`, `Klass.method`, and `Klass.#method`.
+
+```
+you    > @ruboty rurema Enumerable
+ruboty > https://docs.ruby-lang.org/ja/latest/class/Enumerable.html 
+
+you    > @ruboty rurema Object#then
+ruboty > https://docs.ruby-lang.org/ja/latest/method/Object/i/then.html 
+
+you    > @ruboty rurema JSON.parse
+ruboty > https://docs.ruby-lang.org/ja/2.6.0/method/JSON/m/parse.html 
+
+you    > @ruboty rurema Math.#sin
+ruboty > https://docs.ruby-lang.org/ja/latest/method/Math/m/sin.html
+```
+
+Ruboty is also aware of free style text. It passes to https://docs.ruby-lang.org/ja/search/ as a query.
+
+```
+you    > @ruboty rurema 正規表現
+ruboty > https://docs.ruby-lang.org/ja/2.6.0/doc/spec=2fregexp.html
+
+you    > @ruboty rurema then
+ruboty > https://docs.ruby-lang.org/ja/2.6.0/method/Object/i/then.html 
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/pocke/ruboty-rurema.
+
+
+## License
+
+
+These codes are licensed under CC0, except code that is copied from [bitclust](https://github.com/rurema/bitclust/blob/ba4b07e05ae41694e4930d7be355d32e9f17f396/lib/bitclust/nameutils.rb#L205-L208).
+
+[![CC0](http://i.creativecommons.org/p/zero/1.0/88x31.png "CC0")](http://creativecommons.org/publicdomain/zero/1.0/deed.en)

data/Rakefile

@@ -0,0 +1,2 @@
+require "bundler/gem_tasks"
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "ruboty/rurema"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/ruboty/rurema/version.rb

@@ -0,0 +1,5 @@
+module Ruboty
+  module Rurema
+    VERSION = "0.1.0"
+  end
+end

data/lib/ruboty/rurema.rb

@@ -0,0 +1,108 @@
+require "ruboty/rurema/version"
+
+require 'net/https'
+require 'uri'
+require 'json'
+require 'open-uri'
+require 'cgi'
+
+module Ruboty
+  module Handlers
+    class Rurema < Base
+      URL_BASE = 'https://docs.ruby-lang.org/ja/latest/'
+      SEARCH_API_URL_BASE = 'https://docs.ruby-lang.org/ja/search/api:v1/'
+      CLASS_RE = /[A-Z][\w:]+/
+
+      on(
+         /rurema\s+(?<query>.+)/i,
+         name: 'rurema',
+         description: "Response the Ruby reference manual",
+      )
+
+      def rurema(message)
+        query = message.match_data['query']
+        url = build_url(query)
+        if url && exist_resource?(url)
+          message.reply url
+          return
+        end
+
+        # Is CGI.escape correct way?
+        resp = get SEARCH_API_URL_BASE + query.split.map {|q| "query:#{CGI.escape(q)}"}.join('/')
+        if resp.nil? || resp[:entries].empty?
+          message.reply "No document for #{query}"
+          return
+        end
+
+        url = resp.dig(:entries, 0, :documents, -1, :url)
+        # BUG: rurema searcher returns URL with 'https://docs.ruby-lang.org/ja/search/', so we need removing it.
+        url.sub!('docs.ruby-lang.org/ja/search/http://', '')
+        message.reply url
+      end
+
+      private def build_url(query)
+        case
+        when klass = class?(query)
+          URL_BASE + "class/#{encode_name(klass)}.html"
+        when ok = module_method?(query)
+          klass = encode_name ok[0]
+          method = encode_name ok[1]
+          URL_BASE + "method/#{klass}/m/#{method}.html"
+        when ok = instance_method?(query)
+          klass = encode_name ok[0]
+          method = encode_name ok[1]
+          URL_BASE + "method/#{klass}/i/#{method}.html"
+        when ok = class_method?(query)
+          klass = encode_name ok[0]
+          method = encode_name ok[1]
+          URL_BASE + "method/#{klass}/s/#{method}.html"
+        else
+          nil
+        end
+      end
+
+      private def class?(query)
+        query[/\A#{CLASS_RE}\z/]
+      end
+
+      private def module_method?(query)
+        m = /\A(?<class>#{CLASS_RE})\.\#(?<method>.+)\z/.match(query)
+        [m['class'], m['method']] if m
+      end
+
+      private def instance_method?(query)
+        m = /\A(?<class>#{CLASS_RE})\#(?<method>.+)\z/.match(query)
+        [m['class'], m['method']] if m
+      end
+
+      private def class_method?(query)
+        m = /\A(?<class>#{CLASS_RE})\.(?<method>.+)\z/.match(query)
+        [m['class'], m['method']] if m
+      end
+
+      private def exist_resource?(url)
+        url = URI.parse(url)
+        https = Net::HTTP.new(url.host, 443)
+        https.use_ssl = true
+        https.start do
+          resp = https.head(url.path)
+          return resp.code_type == Net::HTTPOK
+        end
+      end
+
+      # It is copied and modified from bitclust.
+      # The license for the method follows bitclust's one.
+      # https://github.com/rurema/bitclust/blob/ba4b07e05ae41694e4930d7be355d32e9f17f396/lib/bitclust/nameutils.rb#L205-L208
+      private def encode_name(name)
+        name.gsub(/[^A-Za-z0-9_]/n) {|ch| sprintf('=%02x', ch.ord) }
+      end
+
+      private def get(url)
+        JSON.parse(URI.open(url).read, symbolize_names: true)
+      rescue OpenURI::HTTPError => ex
+        p ex
+        nil
+      end
+    end
+  end
+end

data/ruboty-rurema.gemspec

@@ -0,0 +1,30 @@
+require_relative 'lib/ruboty/rurema/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "ruboty-rurema"
+  spec.version       = Ruboty::Rurema::VERSION
+  spec.authors       = ["Masataka Pocke Kuwabara"]
+  spec.email         = ["kuwabara@pocke.me"]
+
+  spec.summary       = %q{Search the Ruby Reference Manual via Ruboty}
+  spec.description   = %q{Search the Ruby Reference Manual via Ruboty}
+  spec.homepage      = "https://github.com/pocke/ruboty-rurema"
+  spec.required_ruby_version = Gem::Requirement.new(">= 2.3.0")
+
+  spec.metadata["allowed_push_host"] = "https://rubygems.org"
+
+  spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["source_code_uri"] = spec.homepage
+  # spec.metadata["changelog_uri"] = "TODO: Put your gem's CHANGELOG.md URL here."
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files         = Dir.chdir(File.expand_path('..', __FILE__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_runtime_dependency "ruboty"
+end

metadata

@@ -0,0 +1,69 @@
+--- !ruby/object:Gem::Specification
+name: ruboty-rurema
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Masataka Pocke Kuwabara
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2019-08-24 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: ruboty
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Search the Ruby Reference Manual via Ruboty
+email:
+- kuwabara@pocke.me
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/ruboty/rurema.rb
+- lib/ruboty/rurema/version.rb
+- ruboty-rurema.gemspec
+homepage: https://github.com/pocke/ruboty-rurema
+licenses: []
+metadata:
+  allowed_push_host: https://rubygems.org
+  homepage_uri: https://github.com/pocke/ruboty-rurema
+  source_code_uri: https://github.com/pocke/ruboty-rurema
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.3.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.0.3
+signing_key: 
+specification_version: 4
+summary: Search the Ruby Reference Manual via Ruboty
+test_files: []