ruremai 0.0.1

Sign up to get free protection for your applications and to get access to all the features.
@@ -0,0 +1,17 @@
1
+ *.gem
2
+ *.rbc
3
+ .bundle
4
+ .config
5
+ .yardoc
6
+ Gemfile.lock
7
+ InstalledFiles
8
+ _yardoc
9
+ coverage
10
+ doc/
11
+ lib/bundler/man
12
+ pkg
13
+ rdoc
14
+ spec/reports
15
+ test/tmp
16
+ test/version_tmp
17
+ tmp
data/Gemfile ADDED
@@ -0,0 +1,4 @@
1
+ source 'https://rubygems.org'
2
+
3
+ # Specify your gem's dependencies in rurerurema.gemspec
4
+ gemspec
data/LICENSE ADDED
@@ -0,0 +1,22 @@
1
+ Copyright (c) 2012 hibariya
2
+
3
+ MIT License
4
+
5
+ Permission is hereby granted, free of charge, to any person obtaining
6
+ a copy of this software and associated documentation files (the
7
+ "Software"), to deal in the Software without restriction, including
8
+ without limitation the rights to use, copy, modify, merge, publish,
9
+ distribute, sublicense, and/or sell copies of the Software, and to
10
+ permit persons to whom the Software is furnished to do so, subject to
11
+ the following conditions:
12
+
13
+ The above copyright notice and this permission notice shall be
14
+ included in all copies or substantial portions of the Software.
15
+
16
+ THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
17
+ EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
18
+ MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
19
+ NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
20
+ LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
21
+ OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
22
+ WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
@@ -0,0 +1,43 @@
1
+ # Ruremai
2
+
3
+ Open ruby reference manual by browser as following.
4
+
5
+ ```ruby
6
+ Object.method(:name).rurema!
7
+ ```
8
+
9
+ ## Installation
10
+
11
+ Add this line to your application's Gemfile:
12
+
13
+ gem 'ruremai'
14
+
15
+ And then execute:
16
+
17
+ $ bundle
18
+
19
+ Or install it yourself as:
20
+
21
+ $ gem install ruremai
22
+
23
+ ## Usage
24
+
25
+ ```ruby
26
+ Object.method(:name).rurema!
27
+ ```
28
+
29
+ ```ruby
30
+ (something.methods - methods).sort.each {|m| something.method(m).rurema! }
31
+ ```
32
+
33
+ ## TODO
34
+
35
+ * Support other manuals.
36
+
37
+ ## Contributing
38
+
39
+ 1. Fork it
40
+ 2. Create your feature branch (`git checkout -b my-new-feature`)
41
+ 3. Commit your changes (`git commit -am 'Add some feature'`)
42
+ 4. Push to the branch (`git push origin my-new-feature`)
43
+ 5. Create new Pull Request
@@ -0,0 +1,2 @@
1
+ #!/usr/bin/env rake
2
+ require "bundler/gem_tasks"
@@ -0,0 +1,40 @@
1
+ require 'uri'
2
+ require 'cgi'
3
+ require 'net/http'
4
+ require 'launchy'
5
+ require 'ruremai/version'
6
+ require 'ruremai/ext/method'
7
+
8
+ module Ruremai
9
+ autoload :Locator, 'ruremai/locator'
10
+
11
+ class NoReferenceManualFound < StandardError; end
12
+
13
+ class << self
14
+ def launch(method)
15
+ if uri = locate(method)
16
+ Launchy.open uri.to_s
17
+ else
18
+ raise NoReferenceManualFound
19
+ end
20
+ end
21
+
22
+ def locate(method)
23
+ locate_all(method).first
24
+ end
25
+
26
+ def locate_all(method)
27
+ locators.map {|locator|
28
+ locator.locate(method)
29
+ }.compact
30
+ end
31
+
32
+ def locators
33
+ @locators ||= [Locator::Rurema::Ja]
34
+ end
35
+
36
+ def locators=(list)
37
+ @locators = list
38
+ end
39
+ end
40
+ end
@@ -0,0 +1,5 @@
1
+ class Method
2
+ def rurema!
3
+ Ruremai.launch self
4
+ end
5
+ end
@@ -0,0 +1,44 @@
1
+ module Ruremai
2
+ module Locator
3
+ autoload :Rurema, 'ruremai/locator/rurema'
4
+
5
+ class Base
6
+ class << self
7
+ def locate(method)
8
+ new(method).located
9
+ end
10
+ end
11
+
12
+ attr_reader :name, :owner
13
+
14
+ def initialize(method)
15
+ @method = method
16
+ @name = method.name
17
+ @owner = method.owner
18
+ end
19
+
20
+ def located
21
+ candidates.detect {|uri| exist?(uri) }
22
+ end
23
+
24
+ private
25
+
26
+ def candidates
27
+ []
28
+ end
29
+
30
+ def exist?(uri)
31
+ Net::HTTP.start(uri.host, uri.port) {|http|
32
+ response = http.head(uri.path)
33
+
34
+ case response.code
35
+ when *%w(200 301 302) # FIXME: others?
36
+ true
37
+ else
38
+ false
39
+ end
40
+ }
41
+ end
42
+ end
43
+ end
44
+ end
@@ -0,0 +1,22 @@
1
+ module Ruremai
2
+ module Locator
3
+ module Rurema
4
+ class Ja < Base
5
+ private
6
+
7
+ def uri_base
8
+ 'http://doc.ruby-lang.org/ja/'
9
+ end
10
+
11
+ def candidates
12
+ uri_part = [RUBY_VERSION, 'method', owner.name.gsub(/::/, '/')].join('/')
13
+ method_name = CGI.escape(name.to_s).gsub(/%/, '=').downcase # XXX
14
+
15
+ %w(i s m).map {|type|
16
+ URI.parse("#{uri_base}/#{uri_part}/#{type}/#{method_name}.html")
17
+ }
18
+ end
19
+ end
20
+ end
21
+ end
22
+ end
@@ -0,0 +1,3 @@
1
+ module Ruremai
2
+ VERSION = '0.0.1'
3
+ end
@@ -0,0 +1,21 @@
1
+ # -*- encoding: utf-8 -*-
2
+ require File.expand_path('../lib/ruremai/version', __FILE__)
3
+
4
+ Gem::Specification.new do |gem|
5
+ gem.authors = ['hibariya']
6
+ gem.email = ['celluloid.key@gmail.com']
7
+ gem.description = %q{Open ruby reference manual by browser.}
8
+ gem.summary = %q{Object.method(:name).rurema!}
9
+ gem.homepage = 'https://github.com/hibariya/ruremai'
10
+
11
+ gem.files = `git ls-files`.split($\)
12
+ gem.executables = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
13
+ gem.test_files = gem.files.grep(%r{^(test|spec|features)/})
14
+ gem.name = 'ruremai'
15
+ gem.require_paths = ['lib']
16
+ gem.version = Ruremai::VERSION
17
+
18
+ gem.add_runtime_dependency 'launchy', '~> 2.1.0'
19
+
20
+ gem.add_development_dependency 'tapp', '~> 1.3.1'
21
+ end
metadata ADDED
@@ -0,0 +1,88 @@
1
+ --- !ruby/object:Gem::Specification
2
+ name: ruremai
3
+ version: !ruby/object:Gem::Version
4
+ version: 0.0.1
5
+ prerelease:
6
+ platform: ruby
7
+ authors:
8
+ - hibariya
9
+ autorequire:
10
+ bindir: bin
11
+ cert_chain: []
12
+ date: 2012-07-23 00:00:00.000000000 Z
13
+ dependencies:
14
+ - !ruby/object:Gem::Dependency
15
+ name: launchy
16
+ requirement: !ruby/object:Gem::Requirement
17
+ none: false
18
+ requirements:
19
+ - - ~>
20
+ - !ruby/object:Gem::Version
21
+ version: 2.1.0
22
+ type: :runtime
23
+ prerelease: false
24
+ version_requirements: !ruby/object:Gem::Requirement
25
+ none: false
26
+ requirements:
27
+ - - ~>
28
+ - !ruby/object:Gem::Version
29
+ version: 2.1.0
30
+ - !ruby/object:Gem::Dependency
31
+ name: tapp
32
+ requirement: !ruby/object:Gem::Requirement
33
+ none: false
34
+ requirements:
35
+ - - ~>
36
+ - !ruby/object:Gem::Version
37
+ version: 1.3.1
38
+ type: :development
39
+ prerelease: false
40
+ version_requirements: !ruby/object:Gem::Requirement
41
+ none: false
42
+ requirements:
43
+ - - ~>
44
+ - !ruby/object:Gem::Version
45
+ version: 1.3.1
46
+ description: Open ruby reference manual by browser.
47
+ email:
48
+ - celluloid.key@gmail.com
49
+ executables: []
50
+ extensions: []
51
+ extra_rdoc_files: []
52
+ files:
53
+ - .gitignore
54
+ - Gemfile
55
+ - LICENSE
56
+ - README.md
57
+ - Rakefile
58
+ - lib/ruremai.rb
59
+ - lib/ruremai/ext/method.rb
60
+ - lib/ruremai/locator.rb
61
+ - lib/ruremai/locator/rurema.rb
62
+ - lib/ruremai/version.rb
63
+ - ruremai.gemspec
64
+ homepage: https://github.com/hibariya/ruremai
65
+ licenses: []
66
+ post_install_message:
67
+ rdoc_options: []
68
+ require_paths:
69
+ - lib
70
+ required_ruby_version: !ruby/object:Gem::Requirement
71
+ none: false
72
+ requirements:
73
+ - - ! '>='
74
+ - !ruby/object:Gem::Version
75
+ version: '0'
76
+ required_rubygems_version: !ruby/object:Gem::Requirement
77
+ none: false
78
+ requirements:
79
+ - - ! '>='
80
+ - !ruby/object:Gem::Version
81
+ version: '0'
82
+ requirements: []
83
+ rubyforge_project:
84
+ rubygems_version: 1.8.23
85
+ signing_key:
86
+ specification_version: 3
87
+ summary: Object.method(:name).rurema!
88
+ test_files: []