argh 0.0.1

data/lib/argh.rb

@@ -0,0 +1,11 @@
+module Argh
+
+  base = File.dirname(File.expand_path(__FILE__))
+
+  autoload :Attributable, base + '/argh/attributable'
+  autoload :Collector, base + '/argh/collector'
+  autoload :Formatters, base + '/argh/formatters'
+
+  autoload :VERSION, base + '/argh/version'
+
+end

data/lib/argh/attributable.rb

@@ -0,0 +1,26 @@
+module Argh
+  module Attributable
+
+    DEFAULT_FORMATTER = Formatters::JCommanderFormatter
+
+    def self.included(base)
+      base.extend(ClassMethods)
+    end
+
+    module ClassMethods
+
+      def argh(name, formatter_klass = DEFAULT_FORMATTER, &block)
+        collector = Collector.new(&block)
+        mod = Module.new
+        mod.send(:define_method, name) do
+          formatter = formatter_klass.new collector, self
+          formatter.process
+        end
+        # Extend this module onto ourselves
+        self.send(:include, mod)
+      end
+
+    end
+
+  end
+end

data/lib/argh/collector.rb

@@ -0,0 +1,21 @@
+module Argh
+
+  class Collector
+
+    attr_reader :attributes
+
+    def initialize(&block)
+      @attributes = []
+      instance_eval(&block)
+    end
+
+    def attribute(name, &block)
+      @attributes << {
+        :name => name,
+        :lambda => block || lambda { |i| i.send(name) }
+      }
+    end
+
+  end
+
+end

data/lib/argh/formatters.rb

@@ -0,0 +1,10 @@
+module Argh
+  module Formatters
+
+    base = File.dirname(File.expand_path(__FILE__))
+
+    autoload :JCommanderFormatter, base + '/formatters/jcommander_formatter'
+    autoload :BaseFormatter, base + '/formatters/base_formatter'
+
+  end
+end

data/lib/argh/formatters/base_formatter.rb

@@ -0,0 +1,26 @@
+module Argh
+  module Formatters
+
+    class BaseFormatter
+
+      def initialize(collector, context)
+        @collector = collector
+        @context = context
+      end
+
+      def attributes(&block)
+        return enum_for(:attributes) unless block_given?
+        @collector.attributes.each do |attr|
+          value = @context.instance_eval(&attr[:lambda])
+          yield attr[:name], value
+        end
+      end
+
+      def process
+        raise 'BaseFormatter should be subclassed'
+      end
+
+    end
+
+  end
+end

data/lib/argh/formatters/jcommander_formatter.rb

@@ -0,0 +1,31 @@
+module Argh
+  module Formatters
+
+    class JCommanderFormatter < BaseFormatter
+
+      def process
+        information = []
+        attributes.each do |name, value|
+          piece = escape(name, value)
+          information << piece unless piece.nil?
+        end
+        information.join ' '
+      end
+
+      private
+
+      # NOTE: Strings need to be escaped when they contain a single-quote,
+      # by breaking the quote, inserting a ' (escaped) and then re-opening
+      def escape(name, value)
+        case value
+        when NilClass, FalseClass then nil
+        when TrueClass then "-#{name}"
+        when Fixnum then "-#{name} #{value}"
+        else "-#{name} '#{value.to_s.gsub(%q{'}) { %q{'\''} }}'"
+        end
+      end
+
+    end
+
+  end
+end

data/lib/argh/version.rb

@@ -0,0 +1,5 @@
+module Argh
+
+  VERSION = '0.0.1'
+
+end

data/spec/examples/basic_spec.rb

@@ -0,0 +1,68 @@
+require_relative '../spec_helper'
+
+# To facilitate example below
+class BasicExample
+
+  include Argh::Attributable
+
+  argh 'single' do
+    attribute :name
+  end
+
+  argh 'multiple' do
+    attribute :name
+    attribute :age
+  end
+
+  argh 'multiple_reverse' do
+    attribute :age
+    attribute :name
+  end
+
+  argh 'lambs' do
+    attribute(:name) { name.reverse }
+  end
+
+  private
+
+  def name
+    'John Crepezzi'
+  end
+
+  def age
+    26
+  end
+
+end
+
+##########
+
+describe Argh::Attributable do
+
+  let(:example) { BasicExample.new }
+
+  it 'should have a version' do
+    Argh::VERSION.should be_a(String)
+  end
+
+  it 'better not define #attribute on example instance' do
+    example.should_not respond_to(:attribute)
+  end
+
+  it 'should get the value of existing properties' do
+    example.single.should == '-name \'John Crepezzi\''
+  end
+
+  it 'should be able to serialize multiple attributes' do
+    example.multiple.should == '-name \'John Crepezzi\' -age 26'
+  end
+
+  it 'should be always bring back attributes in order' do
+    example.multiple_reverse.should == '-age 26 -name \'John Crepezzi\''
+  end
+
+  it 'should be able to specify a lambda instead of the original' do
+    example.lambs.should == '-name \'izzeperC nhoJ\''
+  end
+
+end

data/spec/examples/jcommander_spec.rb

@@ -0,0 +1,87 @@
+require_relative '../spec_helper'
+
+# To facilitate examples
+class JCommanderExample
+  attr_accessor :attr
+  include Argh::Attributable
+  argh 'console_attributes', Argh::Formatters::JCommanderFormatter do
+    attribute :attr
+  end
+end
+
+##########
+
+describe Argh::Formatters::JCommanderFormatter do
+
+  let(:attr) { nil }
+  let(:result) do
+    example = JCommanderExample.new
+    example.attr = attr
+    example.console_attributes
+  end
+
+  describe 'with a fixnum attribute' do
+
+    let(:attr) { 123 }
+
+    it 'should return the arguments properly' do
+      result.should == '-attr 123'
+    end
+
+  end
+
+  describe 'with a true attribute' do
+
+    let(:attr) { true }
+
+    it 'should return only the name of the attribute' do
+      result.should == '-attr'
+    end
+
+  end
+
+  describe 'with a false attribute' do
+
+    let(:attr) { false }
+
+    it 'should return an empty string' do
+      result.should == ''
+    end
+
+  end
+
+  describe 'with a nil attribute' do
+
+    let(:attr) { nil }
+
+    it 'should return an empty string' do
+      result.should == ''
+    end
+
+  end
+
+  describe 'with a string attribute' do
+
+    describe 'a clear string' do
+
+      let(:attr) { 'John Crepezzi' }
+
+      it 'should return the arguments properly' do
+        result.should == %q{-attr 'John Crepezzi'}
+      end
+
+    end
+
+    describe 'a string including single quotes' do
+
+      let(:attr) { 'John \' Crepezzi' }
+
+      it 'should return the arguments properly escaped' do
+        result.should == %q{-attr 'John '\'' Crepezzi'}
+      end
+
+    end
+
+  end
+
+end

data/spec/spec_helper.rb

@@ -0,0 +1 @@
+require_relative '../lib/argh'

metadata

@@ -0,0 +1,73 @@
+--- !ruby/object:Gem::Specification
+name: argh
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- John Crepezzi
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-10-13 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Easy command-line argument building in Ruby
+email: johnc@broadstreetads.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/argh/attributable.rb
+- lib/argh/collector.rb
+- lib/argh/formatters/base_formatter.rb
+- lib/argh/formatters/jcommander_formatter.rb
+- lib/argh/formatters.rb
+- lib/argh/version.rb
+- lib/argh.rb
+- spec/examples/basic_spec.rb
+- spec/examples/jcommander_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/broadstreetads/argh
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.24
+signing_key: 
+specification_version: 3
+summary: Easy command-line arguments
+test_files:
+- spec/examples/basic_spec.rb
+- spec/examples/jcommander_spec.rb
+- spec/spec_helper.rb