console_command 0.0.2

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2012 Takatoshi Matsumoto
+
+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/README.md

@@ -0,0 +1,56 @@
+
+# ConsoleCommand
+
+This Rails plugin is enable to add command easily to `rails console` even if it is using which of pry and irb.
+
+## Usage
+
+In your Gemfile.
+
+```ruby
+group :development do
+  gem "console_command"
+end
+```
+
+and puts ruby script as follows in `config/console_command/`. Some examples are in [examples/](https://github.com/ToQoz/console_command/tree/master/examples)
+
+```ruby
+# config/console_command/what_time_is_it_now.rb
+# CC aliased to ConsoleCommand
+CC.define_command('what-time-is-it-now') do |c|
+  c.description "display current time" # this infomation is used only by pry
+  c.group "Joke"                       # this infomation is used only by pry
+  c.options do |opts|                  # this infomation is used only by pry
+    opt.banner unindent <<-USAGE
+      Usage: what-time-is-it-now
+
+      display what-time-is-it-now
+    USAGE
+  end
+  c.process do
+    puts Time.now
+  end
+end
+```
+
+and start rails console and execute command.
+
+**If you use irb for `rails console`, hyphen in command name is automatically converted to underscore.** Because we can't use hyphen for command name in irb
+
+```sh
+# with pry
+$ rails console
+[1] pry(main)> what-time-is-it-now
+2012-12-22 17:26:26 +0900
+[2] pry(main)> help
+...
+Joke
+  what-time-is-it-now display current time
+...
+
+# with irb
+$ rails console
+irb(main):001:0> what_time_is_it_now
+2012-12-22 17:26:26 +0900
+```

data/Rakefile

@@ -0,0 +1,27 @@
+#!/usr/bin/env rake
+begin
+  require 'bundler/setup'
+rescue LoadError
+  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+end
+begin
+  require 'rdoc/task'
+rescue LoadError
+  require 'rdoc/rdoc'
+  require 'rake/rdoctask'
+  RDoc::Task = Rake::RDocTask
+end
+
+RDoc::Task.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'ConsoleCommand'
+  rdoc.options << '--line-numbers'
+  rdoc.rdoc_files.include('README.rdoc')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+
+
+
+Bundler::GemHelper.install_tasks
+

data/lib/console_command.rb

@@ -0,0 +1,11 @@
+# -*- coding: utf-8 -*-
+
+require 'active_support'
+require 'console_command/command'
+require 'console_command/railtie'
+
+module ConsoleCommand
+  extend self
+  delegate :define_command, :to => :Command
+end
+CC = ConsoleCommand

data/lib/console_command/command.rb

@@ -0,0 +1,63 @@
+# -*- coding: utf-8 -*-
+
+module ConsoleCommand
+  class Command
+
+    class << self
+      def define_command(name)
+        command = new(name.to_s)
+        yield command
+        command.add_to_irb_command
+        command.add_to_pry_command if defined? Pry
+      end
+    end
+
+    [ :name, :description, :group, :options, :process ].each do |name|
+      define_method(name) do |value = nil, &block|
+        if value
+          instance_variable_set "@#{name}", value
+        elsif block
+          instance_variable_set "@#{name}", block
+        else
+          attrribute = instance_variable_get "@#{name}"
+          attrribute.respond_to?(:call) ? attrribute.call : attrribute
+        end
+      end
+    end
+
+    def initialize(name)
+      @name = name
+    end
+
+    def add_to_pry_command
+      command = self
+      command_sets = Pry::CommandSet.new
+      command_sets.create_command(name) do
+        group command.group
+        description command.description
+        define_method(:process) do
+          command.process
+        end
+        define_method(:options) do |opts|
+          command.options opts
+        end
+      end
+      Pry.commands.import command_sets
+    end
+
+    def add_to_irb_command
+      require 'irb'
+      require 'irb/cmd/nop'
+      command = self
+      command_class = Class.new IRB::ExtendCommand::Nop do
+        define_method :execute do
+          command.process
+        end
+      end
+      irb_cmd_name = name.gsub('-', '_')
+      class_name = irb_cmd_name.to_s.classify
+      IRB::ExtendCommand.const_set class_name, command_class
+      IRB::ExtendCommandBundle.def_extend_command irb_cmd_name, class_name
+    end
+  end
+end

data/lib/console_command/railtie.rb

@@ -0,0 +1,13 @@
+# -*- coding: utf-8 -*-
+
+module ConsoleCommand
+  class Railtie < Rails::Railtie
+    console do
+      command_glob = Rails.root.join('config/console_command/*.rb')
+
+      Dir[command_glob].each do |command|
+        require command
+      end
+    end
+  end
+end

data/lib/console_command/version.rb

@@ -0,0 +1,3 @@
+module ConsoleCommand
+  VERSION = "0.0.2"
+end

data/lib/tasks/console_command_tasks.rake

@@ -0,0 +1,4 @@
+# desc "Explaining what the task does"
+# task :console_command do
+#   # Task goes here
+# end

metadata

@@ -0,0 +1,109 @@
+--- !ruby/object:Gem::Specification
+name: console_command
+version: !ruby/object:Gem::Version
+  prerelease: 
+  version: 0.0.2
+platform: ruby
+authors:
+- Takatoshi Matsumoto
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-12-22 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  type: :runtime
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '3.2'
+  name: rails
+  prerelease: false
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '3.2'
+- !ruby/object:Gem::Dependency
+  type: :development
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  name: sqlite3
+  prerelease: false
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  type: :development
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  name: rspec-rails
+  prerelease: false
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: This Rails plugin is enable to add command easily to `rails console`
+  even if it is using which of pry and irb
+email:
+- toqoz403@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/console_command/command.rb
+- lib/console_command/railtie.rb
+- lib/console_command/version.rb
+- lib/console_command.rb
+- lib/tasks/console_command_tasks.rake
+- MIT-LICENSE
+- Rakefile
+- README.md
+homepage: http://github.com/ToQoz/console_command
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      segments:
+      - 0
+      hash: -446349457083776481
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      segments:
+      - 0
+      hash: -446349457083776481
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.24
+signing_key: 
+specification_version: 3
+summary: This is Rails plugin provides DSL for adding command in `rails console` (pry
+  and irb.)
+test_files: []