scripting 0.1.0

data/Gemfile

@@ -0,0 +1,9 @@
+source "http://rubygems.org"
+
+# Add dependencies to develop your gem here.
+# Include everything needed to run rake, tests, features, etc.
+group :development do
+  gem "rspec", ">= 1.0.0"
+  gem "jeweler", "~> 1.5.2"
+  gem "rcov", ">= 0"
+end

data/Gemfile.lock

@@ -0,0 +1,27 @@
+GEM
+  remote: http://rubygems.org/
+  specs:
+    diff-lcs (1.1.2)
+    git (1.2.5)
+    jeweler (1.5.2)
+      bundler (~> 1.0.0)
+      git (>= 1.2.5)
+      rake
+    rake (0.8.7)
+    rcov (0.9.9)
+    rspec (2.5.0)
+      rspec-core (~> 2.5.0)
+      rspec-expectations (~> 2.5.0)
+      rspec-mocks (~> 2.5.0)
+    rspec-core (2.5.1)
+    rspec-expectations (2.5.0)
+      diff-lcs (~> 1.1.2)
+    rspec-mocks (2.5.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  jeweler (~> 1.5.2)
+  rcov
+  rspec (>= 1.0.0)

data/LICENSE.txt

@@ -0,0 +1,20 @@
+Copyright (c) 2011 Scott Deming
+
+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.rdoc

@@ -0,0 +1,40 @@
+= Scripting
+
+Scripting is a pluggable command line scripting API for Ruby.
+
+Writing command line scripts is a process that repeats itself over and over
+again. We deal with command line switches. We deal with maintaining options
+set by the command line switches. Then finally, we perform the desired task.
+
+Time to simplify.
+
+By default Scripting provides the general tools needed to write command line
+scripts quickly and easily. The default parsing mechanics are provided by
+optparse. Options are maintained in an object that allows maximum flexibility
+while easing the pain of deailing with hash names (is the key a symbol or a
+string?). Options can be blocks that update other options, return an object
+instance, or they can be simple primitive values like true and false, 0, or
+a string.
+
+The overall goal of Scripting is to provide an easy to read and write DSL
+that makes writing command line scripts more tolerable.
+
+== Example
+
+See examples/
+
+== Contributing to scripting
+
+* Check out the latest master to make sure the feature hasn't been implemented or the bug hasn't been fixed yet
+* Check out the issue tracker to make sure someone already hasn't requested it and/or contributed it
+* Fork the project
+* Start a feature/bugfix branch
+* Commit and push until you are happy with your contribution
+* Make sure to add tests for it. This is important so I don't break it in a future version unintentionally.
+* Please try not to mess with the Rakefile, version, or history. If you want to have your own version, or is otherwise necessary, that is fine, but please isolate to its own commit so I can cherry-pick around it.
+
+== Copyright
+
+Copyright (c) 2011 Scott Deming. See LICENSE.txt for
+further details.
+

data/Rakefile

@@ -0,0 +1,50 @@
+require 'rubygems'
+require 'bundler'
+begin
+  Bundler.setup(:default, :development)
+rescue Bundler::BundlerError => e
+  $stderr.puts e.message
+  $stderr.puts "Run `bundle install` to install missing gems"
+  exit e.status_code
+end
+require 'rake'
+
+require 'jeweler'
+Jeweler::Tasks.new do |gem|
+  # gem is a Gem::Specification... see http://docs.rubygems.org/read/chapter/20 for more options
+  gem.name = "scripting"
+  gem.homepage = "http://github.com/sdeming/scripting"
+  gem.license = "MIT"
+  gem.summary = %Q{Simplified command line scripting tool}
+  gem.description = %Q{Simplified command line scripting tool}
+  gem.email = "sdeming@makefile.com"
+  gem.authors = ["sdeming"]
+  # Include your dependencies below. Runtime dependencies are required when using your gem,
+  # and development dependencies are only needed for development (ie running rake tasks, tests, etc)
+  #  gem.add_runtime_dependency 'jabber4r', '> 0.1'
+  #  gem.add_development_dependency 'rspec', '> 1.2.3'
+end
+Jeweler::RubygemsDotOrgTasks.new
+
+require 'rspec/core'
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new(:spec) do |spec|
+  spec.pattern = FileList['spec/**/*_spec.rb']
+end
+
+RSpec::Core::RakeTask.new(:rcov) do |spec|
+  spec.pattern = 'spec/**/*_spec.rb'
+  spec.rcov = true
+end
+
+task :default => :spec
+
+require 'rake/rdoctask'
+Rake::RDocTask.new do |rdoc|
+  version = File.exist?('VERSION') ? File.read('VERSION') : ""
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "scripting #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/VERSION

@@ -0,0 +1 @@
+0.1.0

data/examples/simple.rb

@@ -0,0 +1,34 @@
+require File.expand_path('../../lib/scripting', __FILE__)
+
+MyApp = Scripting::create_application do
+  plugin Scripting::AppDefaults
+  uses :default_switches
+  uses :default_options
+
+  options do
+    message { "Hello World" }
+    stdout false
+    stderr false
+  end
+
+  switches do
+    on('-o', '--[no-]stdout', "Write message to STDOUT") do |opt|
+      options.stdout = opt
+    end
+
+    on('-e', '--[no-]stderr', "Write message to STDERR") do |opt|
+      options.stderr = opt
+    end
+
+    on('-m', '--message=TEXT', "Message to write") do |opt|
+      options.message = opt
+    end
+  end
+
+  work do
+    STDERR.puts options.message if options.stderr
+    STDOUT.puts options.message if options.stdout
+  end
+end
+
+MyApp.run! ARGV

data/lib/scripting/app_defaults.rb

@@ -0,0 +1,34 @@
+module Scripting
+  module AppDefaults
+
+    def self.included(base)
+      base.class_eval do
+        plugins :default_switches, :default_options
+      end
+    end
+
+    def default_options(context)
+      context.describe do
+        options do
+          verbose false
+        end
+      end
+    end
+
+    def default_switches(context)
+      context.describe do
+        switches do
+          on_tail('-v', '--verbose', 'Enable verbose output') do
+            options.verbose = true
+          end
+
+          on_tail('-h', '--help', "Help text") do
+            puts self
+            terminate
+          end
+        end
+      end
+    end
+
+  end
+end

data/lib/scripting/application.rb

@@ -0,0 +1,74 @@
+require File.expand_path('../pluggable', __FILE__)
+require File.expand_path('../parser', __FILE__)
+require File.expand_path('../options', __FILE__)
+require File.expand_path('../app_defaults', __FILE__)
+
+module Scripting
+  class Application
+    extend Pluggable
+
+    def initialize
+      @options = Options.new
+      @switches = Parser.new(self)
+      @work = []
+    end
+
+    def context
+      self
+    end
+
+    def describe &blk
+      instance_eval &blk if block_given?
+      self
+    end
+
+    def switches &blk
+      @switches.instance_eval &blk if block_given?
+      @switches
+    end
+
+    def options &blk
+      @options.describe &blk if block_given?
+      @options
+    end
+
+    def work &blk
+      @work << blk if block_given?
+      @work
+    end
+
+    def plugin module_name
+      self.class.send(:include, module_name)
+    end
+
+    def uses *names
+      names.each do |name|
+        name = name.to_sym
+        if installed_plugins.include? name
+          send(name, self)
+        else
+          raise "unknown method '#{name.inspect}' provided in uses"
+        end
+      end
+    end
+
+    def parse! args
+      switches.parse! args
+      args
+    end
+
+    def run! *args
+      if args.first.kind_of? Array
+        args.flatten!
+      end
+      parse! args
+      work.each { |work| instance_exec(*args, &work) }
+    end
+  end
+
+  def self.create_application &blk
+    app = Application.new
+    app.describe &blk
+    app
+  end
+end

data/lib/scripting/options.rb

@@ -0,0 +1,35 @@
+module Scripting
+
+  class Options
+    def describe &blk; instance_eval &blk; end
+
+    def [](name)
+      ivar = "@#{name}"
+      value = instance_variable_get(ivar)
+
+      if value.respond_to? :call
+        instance_eval &value
+      else
+        value
+      end
+    end
+
+    def []=(name, value)
+      ivar = "@#{name}"
+      instance_variable_set(ivar, value)
+    end
+
+    def method_missing(name, value = nil, &blk)
+      name = name.to_s
+      name = name[0..-2] if name =~ /=$/
+
+      if block_given?
+        self[name] = blk
+      elsif !value.nil?
+        self[name] = value
+      else
+        self[name]
+      end
+    end
+  end
+end

data/lib/scripting/parser.rb

@@ -0,0 +1,24 @@
+require 'forwardable'
+require 'delegate'
+require 'optparse'
+
+module Scripting
+  #TODO: flesh this out... We can, ideally, use any options parser but by default we use optparse.
+  def self.CustomParser(klass)
+    custom = Class.new(DelegateClass(klass))
+    custom.class_eval do
+      extend(Forwardable)
+      def_delegators :@context, :context, :options
+      def describe; instance_eval; end
+    end
+
+    custom.send(:define_method, :initialize) do |context|
+      @context = context
+      super(klass.new)
+    end
+
+    custom
+  end
+
+  Parser = Scripting::CustomParser(OptionParser)
+end

data/lib/scripting/pluggable.rb

@@ -0,0 +1,35 @@
+module Scripting
+  module Pluggable
+    module ClassMethods
+      def meta
+        (class << self; self; end)
+      end
+
+      def plugin name
+        plugins = self.meta.instance_variable_get("@__plugins__")
+        plugins << name
+        self.meta.instance_variable_set("@__plugins__", plugins)
+      end
+
+      def plugins *names
+        names.each { |name| self.plugin(name) }
+        self.meta.instance_variable_get("@__plugins__")
+      end
+
+      def self.extended(base)
+        base.meta.instance_variable_set("@__plugins__", [])
+      end
+    end
+
+    module InstanceMethods
+      def installed_plugins
+        self.class.plugins
+      end
+    end
+
+    def self.extended(base)
+      base.send(:extend, ClassMethods)
+      base.send(:include, InstanceMethods)
+    end
+  end
+end

data/lib/scripting.rb

@@ -0,0 +1 @@
+require File.expand_path('../scripting/application', __FILE__)

data/scripting.gemspec

@@ -0,0 +1,69 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run 'rake gemspec'
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{scripting}
+  s.version = "0.1.0"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["sdeming"]
+  s.date = %q{2011-03-06}
+  s.description = %q{Simplified command line scripting tool}
+  s.email = %q{sdeming@makefile.com}
+  s.extra_rdoc_files = [
+    "LICENSE.txt",
+    "README.rdoc"
+  ]
+  s.files = [
+    "Gemfile",
+    "Gemfile.lock",
+    "LICENSE.txt",
+    "README.rdoc",
+    "Rakefile",
+    "VERSION",
+    "examples/simple.rb",
+    "lib/scripting.rb",
+    "lib/scripting/app_defaults.rb",
+    "lib/scripting/application.rb",
+    "lib/scripting/options.rb",
+    "lib/scripting/parser.rb",
+    "lib/scripting/pluggable.rb",
+    "scripting.gemspec",
+    "spec/application_spec.rb",
+    "spec/options_spec.rb",
+    "spec/spec_helper.rb"
+  ]
+  s.homepage = %q{http://github.com/sdeming/scripting}
+  s.licenses = ["MIT"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = %q{1.3.7}
+  s.summary = %q{Simplified command line scripting tool}
+  s.test_files = [
+    "examples/simple.rb",
+    "spec/application_spec.rb",
+    "spec/options_spec.rb",
+    "spec/spec_helper.rb"
+  ]
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
+      s.add_development_dependency(%q<rspec>, [">= 1.0.0"])
+      s.add_development_dependency(%q<jeweler>, ["~> 1.5.2"])
+      s.add_development_dependency(%q<rcov>, [">= 0"])
+    else
+      s.add_dependency(%q<rspec>, [">= 1.0.0"])
+      s.add_dependency(%q<jeweler>, ["~> 1.5.2"])
+      s.add_dependency(%q<rcov>, [">= 0"])
+    end
+  else
+    s.add_dependency(%q<rspec>, [">= 1.0.0"])
+    s.add_dependency(%q<jeweler>, ["~> 1.5.2"])
+    s.add_dependency(%q<rcov>, [">= 0"])
+  end
+end
+

data/spec/application_spec.rb

@@ -0,0 +1,76 @@
+require 'spec_helper'
+
+describe Scripting::Application do
+
+  it "should run a work block" do
+    app = Scripting::create_application do
+      work { options.work1_ran = true }
+    end
+
+    app.options.work1_ran.should be_nil
+    app.run!
+    app.options.work1_ran.should be_true
+  end
+
+  it "should run many work blocks in order" do
+    app = Scripting::create_application do
+      work { options.work_runs = [1] }
+      work { options.work_runs.push 2 }
+      work { options.work_runs.push 3 }
+    end
+
+    app.options.work_runs.should be_nil
+    app.run!
+    app.options.work_runs.should == [1,2,3]
+  end
+
+  it "should pass extra args to work blocks" do
+    app = Scripting::create_application do
+      work do |*extra_args|
+        action = extra_args.first
+        options.action = action
+      end
+    end
+
+    app.options.action.should be_nil
+    app.run! ["digest"]
+    app.options.action.should == "digest"
+  end
+
+  it "should define default options when using AppDefaults plugin" do
+    app = Scripting::create_application do
+      plugin Scripting::AppDefaults
+      uses :default_options
+    end
+    app.options.verbose.should be_false
+  end
+
+  it "should define default switches when using AppDefaults plugin" do
+    app = Scripting::create_application do
+      plugin Scripting::AppDefaults
+      uses :default_switches
+    end
+    app.options.verbose.should be_nil
+    app.parse! ["-v"]
+    app.options.verbose.should be_true
+  end
+
+  it "should define both default options and switches when using AppDefaults plugin" do
+    app1 = Scripting::create_application do
+      plugin Scripting::AppDefaults
+      uses :default_switches
+      uses :default_options
+    end
+    app1.options.verbose.should be_false
+    app1.parse! ["-v"]
+    app1.options.verbose.should be_true
+
+    app2 = Scripting::create_application do
+      plugin Scripting::AppDefaults
+      uses :default_switches, :default_options
+    end
+    app2.options.verbose.should be_false
+    app2.parse! ["-v"]
+    app2.options.verbose.should be_true
+  end
+end

data/spec/options_spec.rb

@@ -0,0 +1,53 @@
+require 'spec_helper'
+
+describe Scripting::Options do
+
+  it "should assign without =" do
+    opts = Scripting::Options.new
+    opts.first :a
+    opts.second :b
+
+    opts.first.should == :a
+    opts.second.should == :b
+  end
+
+  it "should assign with =" do
+    opts = Scripting::Options.new
+    opts.first = :a
+    opts.second = :b
+    opts.third = 3
+
+    opts.first.should == :a
+    opts.second.should == :b
+    opts.third.should == 3
+  end
+
+  it "should assign with or without =" do
+    opts = Scripting::Options.new
+    opts.first = :a
+    opts.second :b
+    opts.third = 3
+    opts.fourth "4"
+
+    opts.first.should == :a
+    opts.second.should == :b
+    opts.third.should == 3
+    opts.fourth.should == "4"
+  end
+
+  it "should assign blocks and call for each visit" do
+    opts = Scripting::Options.new
+    opts.block { true }
+    opts.block.should be_true
+  end
+
+  it "should assign blocks and invoke them in the scope of the entire options instance" do
+    opts = Scripting::Options.new
+    opts.count 0
+    opts.block { self.count += 1 }
+
+    opts.block.should == 1
+    opts.block.should == 2
+  end
+
+end

data/spec/spec_helper.rb

@@ -0,0 +1 @@
+require File.expand_path("../../lib/scripting", __FILE__)

metadata

@@ -0,0 +1,127 @@
+--- !ruby/object:Gem::Specification 
+name: scripting
+version: !ruby/object:Gem::Version 
+  prerelease: false
+  segments: 
+  - 0
+  - 1
+  - 0
+  version: 0.1.0
+platform: ruby
+authors: 
+- sdeming
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-03-06 00:00:00 -05:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: rspec
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 1
+        - 0
+        - 0
+        version: 1.0.0
+  type: :development
+  prerelease: false
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: jeweler
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 1
+        - 5
+        - 2
+        version: 1.5.2
+  type: :development
+  prerelease: false
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  name: rcov
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  prerelease: false
+  version_requirements: *id003
+description: Simplified command line scripting tool
+email: sdeming@makefile.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE.txt
+- README.rdoc
+files: 
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.rdoc
+- Rakefile
+- VERSION
+- examples/simple.rb
+- lib/scripting.rb
+- lib/scripting/app_defaults.rb
+- lib/scripting/application.rb
+- lib/scripting/options.rb
+- lib/scripting/parser.rb
+- lib/scripting/pluggable.rb
+- scripting.gemspec
+- spec/application_spec.rb
+- spec/options_spec.rb
+- spec/spec_helper.rb
+has_rdoc: true
+homepage: http://github.com/sdeming/scripting
+licenses: 
+- MIT
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 1339519597396043880
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.7
+signing_key: 
+specification_version: 3
+summary: Simplified command line scripting tool
+test_files: 
+- examples/simple.rb
+- spec/application_spec.rb
+- spec/options_spec.rb
+- spec/spec_helper.rb