rireader 0.1.0

checksums.yaml

@@ -0,0 +1,15 @@
+---
+!binary "U0hBMQ==":
+  metadata.gz: !binary |-
+    NzViZDIzZWU1NDlhNTNiMjk2ZDkxZmQxZDJmMGQxNGUzMTI2MTRjMg==
+  data.tar.gz: !binary |-
+    ZGYxZTM3MWIyMjgwNmRjM2IwYjljN2Q0MmE0NTgxZjRlNzIzNzhkNA==
+SHA512:
+  metadata.gz: !binary |-
+    ZDAyYzc1ZmE0YTJlMDI5YzI3ZGMwZmVlYjkxNDIyN2I0Njk3NTA1NDE5NWZh
+    MTMxM2MzYTg0ZjJiNWU4NTlmZTMwMWM1MjdjMjUyOTU1NTAyODBkNjg3MGZk
+    YjllZmM2OTIzYmY4ZDdhNTg4Y2I1ZDM5YmUxODk1MjdhNDI0Yzc=
+  data.tar.gz: !binary |-
+    YmYyOGQyZjY1YTdkYjE2MTg1MTI0NzRiMTIxOTNlOGEyNmU2NTI5YmMwOTgx
+    MmMzMTczNjJhODYyYTkzNmFhYWRiOWRlNWNlYTc2MjYwMmYxZTFkNGZkYTE0
+    ODc3NTAxOTM2NmI4YWJhZTEyMGI2OTg5MDFiZjFkYjY1YzM1YmU=

data/README.md

@@ -0,0 +1,42 @@
+Rireader is a graphical user interface to read ri documentation. 
+
+Ruby has a wonderful reference of the language and all available libraries: ri. 
+
+ri stands for “Ruby Interactive”, which is a tool to navigate documentation.
+
+Getting Started
+==========
+If you have Ruby installed, you should have all that’s necessary to use ri. If you are have troubles, look at “Troubleshooting” below.
+
+To try it out, enter the name of the class or method you want documentation about in the entry field and click the buttom=n "get ri documentation". The documentation will be displayed in the text field. 
+
+Typing "Array" should show you the docs for the Array class. If you type "Array.min", the program will provide the documentation for Array’s min instance method. To be very specific about things, use a :: or # for class and instance methods rather than the generic ..
+
+Example:
+
+Array::wrap # class method lookup
+Array#min # instance method lookup
+
+One really useful feature of the tool is the suggestions ri provides when you enter only part of what you are looking for. Try it out:
+
+Enumerable.each
+```
+Enumerable.each not found, maybe you meant:
+
+Enumerable#each_cons
+Enumerable#each_entry
+Enumerable#each_slice
+Enumerable#each_with_index
+Enumerable#each_with_object
+```
+Troubleshooting
+==========
+If you are not in an RVM project and you are unable to find ri documentation, try this:
+```
+gem install rdoc rdoc-data
+rdoc-data --install
+````
+If you are in an RVM project, this should clear things up.
+```
+rvm docs generate-ri
+```

data/lib/rireader.rbw

@@ -0,0 +1,51 @@
+require 'tk'
+
+$var = TkVariable.new
+
+root = TkRoot.new{title "Rireader"}
+root['geometry'] = '1540x700+1+1'
+
+label = TkLabel.new{ text "Enter method or class name >>"
+ borderwidth 5
+ font TkFont.new('times 14 bold')
+ background  "yellow"
+ relief    "groove" 
+}.pack('padx' => 60, 'pady' => 45, 'expand' => 'y')
+
+entry = TkEntry.new{ 
+textvariable $var
+}
+
+text = TkText.new(root){
+background "black"
+foreground "white"
+width 72
+height 20
+font TkFont.new('tahoma 16 bold')
+}
+
+button = TkButton.new{
+text "get ri documentation"
+borderwidth 5
+font TkFont.new('times 14 bold')
+background  "green"
+relief    "groove" 
+command(proc {
+                    content = `ri  --all --format=markdown "#$var"`
+                    text.delete('1.0', 'end');
+                    text.insert('1.0', "#{content}" )
+                     }
+             )
+}.pack('padx' => 30, 'pady' => 15)
+
+scrollbar = TkScrollbar.new(root){command proc{|*args| text.yview(*args)}}
+text.yscrollcommand(proc{|first, last| scrollbar.set(first, last)})
+
+label.grid( 'row' => 0, 'column' => 0, 'sticky' => 'W')
+entry.grid( 'row' => 0, 'column' => 1, 'sticky' => 'W')
+button.grid( 'row' => 0, 'column' => 2, 'sticky' => 'WE')
+text.grid( 'row' => 1, 'columnspan' => 3)
+scrollbar.grid('row' => 1, 'column' => 4, 'sticky' =>'NS')
+
+Tk.mainloop
+

data/rireader.gemspec

@@ -0,0 +1,28 @@
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = "rireader"
+  s.version = "0.1.0"
+  s.licenses    = ['MIT']
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Sabry Abdel Fattah"]
+  s.date = "2015-03-03"
+  s.description = "Rireader is a graphical user interface to read ri documentation."
+  s.email = "sabryabdelfattah@gmail.com"
+  s.extra_rdoc_files = ["README.md"]
+  s.files = ["rireader.gemspec", "lib/rireader.rbw", "README.md"]
+  s.homepage = "http://sabryfattah.com"
+  s.rdoc_options = ["--main", "README.md"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = "1.8.29"
+  s.summary = "Rireader is a graphical user interface to read ri documentation. "
+
+  if s.respond_to? :specification_version then
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
+    else
+    end
+  else
+  end
+end

metadata

@@ -0,0 +1,49 @@
+--- !ruby/object:Gem::Specification
+name: rireader
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Sabry Abdel Fattah
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-03-03 00:00:00.000000000 Z
+dependencies: []
+description: Rireader is a graphical user interface to read ri documentation.
+email: sabryabdelfattah@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files:
+- README.md
+files:
+- README.md
+- lib/rireader.rbw
+- rireader.gemspec
+homepage: http://sabryfattah.com
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options:
+- --main
+- README.md
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.4.5
+signing_key: 
+specification_version: 3
+summary: Rireader is a graphical user interface to read ri documentation.
+test_files: []