motion-docs 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: b46bb74fc9981344cf8dc7b9c6e15284f5b61125
+  data.tar.gz: 843a9ac3b1c059ff9111c750e341adb069d31bf4
+SHA512:
+  metadata.gz: 07dd18c96977c365d00727bda49e5cb2d1942f63a2f0e7f1f1d84d3038ff2eead97683eb3b98be1bd8fe892e360a51c7aa1069ab3ef20f3c5fe7a232a1f64e82
+  data.tar.gz: 0fc804ab1ad878c0ded3951a85d75f4ca9209a587adba7f51643235711ace75aa157366d025cae6565548ef0b8935e53208611b730795e0f25a994923cd24908

data/README.md

@@ -0,0 +1,93 @@
+# MotionDocs
+
+Provides class and method documentation right in your RubyMotion REPL.
+
+## Installation
+
+MotionDocs will only activate if running in simulator.
+
+```ruby
+gem 'motion-docs'
+```
+
+## Usage
+
+Within your RubyMotion REPL, type in `docs` and a string representing what you'd like
+to look up in the documentation.
+
+```sh-session
+(main)> docs "UINavigationController"
+```
+
+You'll get something like this:
+
+![UINavigationController documentation](http://clrsight.co/jh/2015-02-19-o8uh6.png?+)
+
+To look up a method, just use the familiar notation for class and instance methods:
+
+```sh-session
+(main)> docs "UIColor.blueColor"
+ ...
+(main)> docs "UIColor#colorWithAlphaComponent:"
+ ...
+```
+
+As an alternative, you can use `.docs` on a string:
+
+```sh-session
+(main)> "UIColor.redColor".docs
+ ...
+```
+
+Or, for classes, even just on the class itself:
+
+```sh-session
+(main)> UIColor.docs
+ ...
+```
+
+If you give it a class or instance method name, it'll give you documentation for that.
+
+```sh-session
+(main)> UIView.docs("#frame")
+ ...
+(main)> NSObject.docs(".alloc")
+ ...
+```
+
+## Support
+
+File an issue here at Github. Better yet, submit a pull request with a fix. :-)
+But an issue is just fine as well.
+
+## Author
+
+[Jamon Holmgren](https://twitter.com/jamonholmgren)
+
+## License
+
+Copyright (c) 2015 Jamon Holmgren
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+
+
+

data/lib/motion-docs.rb

@@ -0,0 +1,12 @@
+# encoding: utf-8
+
+unless defined?(Motion::Project::Config)
+  raise "This file must be required within a RubyMotion project Rakefile."
+end
+
+lib_dir_path = File.dirname(File.expand_path(__FILE__))
+Motion::Project::App.setup do |app|
+  app.files << "#{lib_dir_path}/motion-docs/version.rb"
+  app.files << "#{lib_dir_path}/motion-docs/motion-docs.rb"
+  app.files << "#{lib_dir_path}/motion-docs/monkeypatching.rb"
+end

data/lib/motion-docs/monkeypatching.rb

@@ -0,0 +1,28 @@
+if !(UIDevice.currentDevice.model =~ /simulator/i).nil?
+  class Object
+    def self.docs(method_name=nil)
+      subject = self.to_s
+      if method_name
+        subject << "." unless method_name.start_with?("#") || method_name.start_with?(".")
+        subject << method_name.to_s
+      end
+      puts MotionDocs.new(subject).help
+    end
+    def self.ri(m=nil); docs(m); end
+  end
+
+  class String
+    def docs
+      puts MotionDocs.new(self).help
+    end
+    alias ri docs
+  end
+
+  module Kernel
+    def docs(subject)
+      puts MotionDocs.new(subject.to_s).help
+      nil
+    end
+    alias ri docs
+  end
+end

data/lib/motion-docs/motion-docs.rb

@@ -0,0 +1,74 @@
+if !(UIDevice.currentDevice.model =~ /simulator/i).nil?
+  class MotionDocs
+    attr_reader :subject
+
+    COLORS = {
+      gray:         "\e[1;30m",
+      red:          "\e[0;31m",
+      light_red:    "\e[1;31m",
+      green:        "\e[0;32m",
+      light_green:  "\e[1;32m",
+      yellow:       "\e[0;33m",
+      light_yellow: "\e[1;33m",
+      blue:         "\e[0;34m",
+      light_blue:   "\e[1;34m",
+      purple:       "\e[0;35m",
+      light_purple: "\e[1;35m",
+      cyan:         "\e[0;36m",
+      light_cyan:   "\e[1;36m",
+      white:        "\e[0m",
+      off:          "\e[0m",
+    }
+
+    def initialize(subject)
+      @subject = subject
+    end
+
+    def help
+      ri_docs = `HOME=/tmp /Library/RubyMotion/lib/yard/bin/yri --db /Library/RubyMotion/doc/yardoc #{subject}`
+      colorized(ri_docs)
+    end
+
+    private
+
+    def colorized(ri_docs)
+      color = :blue
+      ri_docs.split("\n").map do |ri_line|
+        if ri_line == ""
+          nil
+        elsif ri_line.include?("Class:") || ri_line.include?("Method:")
+          color = :blue
+          colored_text ri_line.split(":", 2).last.strip, :light_blue
+        elsif ri_line.start_with? "--------------"
+          nil
+        elsif ri_line == ""
+          nil
+        elsif ri_line == "Includes:"
+          color = :purple
+          colored_text ri_line, :light_purple
+        elsif ri_line == "Class methods:"
+          color = :yellow
+          colored_text ri_line, :light_yellow
+        elsif ri_line == "Instance methods:"
+          color = :green
+          colored_text ri_line, :light_green
+        elsif ri_line == "Direct Known Subclasses:" || ri_line == "Overloads:"
+          color = :cyan
+          colored_text ri_line, :light_cyan
+        elsif ri_line == "Parameters:"
+          color = :gray
+          colored_text ri_line, :white
+        elsif ri_line == "Returns:"
+          color = :red
+          colored_text ri_line, :light_red
+        else
+          colored_text ri_line, color
+        end
+      end.compact.join("\n")
+    end
+
+    def colored_text(ri_line, color=:blue)
+      "#{COLORS[color]}#{ri_line}#{COLORS[:off]}"
+    end
+  end
+end

data/lib/motion-docs/version.rb

@@ -0,0 +1,5 @@
+if !defined?(UIDevice) || !(UIDevice.currentDevice.model =~ /simulator/i).nil?
+  class MotionDocs
+    VERSION = "0.1.0" unless defined?(MotionDocs::VERSION)
+  end
+end

metadata

@@ -0,0 +1,64 @@
+--- !ruby/object:Gem::Specification
+name: motion-docs
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Jamon Holmgren
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-02-20 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Provides class and method documentation right in your RubyMotion REPL.
+  Only activates when running on simulator.
+email:
+- jamon@clearsightstudio.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- README.md
+- lib/motion-docs.rb
+- lib/motion-docs/monkeypatching.rb
+- lib/motion-docs/motion-docs.rb
+- lib/motion-docs/version.rb
+homepage: http://github.com/jamonholmgren/motion-docs
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+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: 4
+summary: Provides class and method documentation right in your RubyMotion REPL.
+test_files: []