shorthand 0.1.0

data/.document

@@ -0,0 +1,5 @@
+README.rdoc
+lib/**/*.rb
+bin/*
+features/**/*.feature
+LICENSE

data/.gitignore

@@ -0,0 +1,21 @@
+## MAC OS
+.DS_Store
+
+## TEXTMATE
+*.tmproj
+tmtags
+
+## EMACS
+*~
+\#*
+.\#*
+
+## VIM
+*.swp
+
+## PROJECT::GENERAL
+coverage
+rdoc
+pkg
+
+## PROJECT::SPECIFIC

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2009 Bruce Williams
+
+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 @@
+Shorthand
+=========
+
+Shorthand gives you an easy way to add a object-focused DSL (an OSL,
+if you will) useful for configuring instances -- without dirtying up
+your class implementation.  This of it as running your DSL in a little
+sandbox.
+
+For example, let's say we have a class, Person:
+
+    class Person
+      # with a lot of accessors
+    end
+
+And we'd like an API like:
+
+    Person.new do
+      name 'Bruce Williams'
+      location 'Portland, OR'
+    end
+
+Provided we had `name=` and `location=` attribute writers defined on
+`Person`, this would be as easy as:
+
+    class Person
+      include Shorthand # this line
+    end
+
+If you prefer yield-style semantics, rest assured this API would work
+as well:
+
+    Person.new do |person|
+      person.name 'Bruce Williams'
+      person.location 'Portland, OR'
+    end
+
+You can also use the `shorthand` method after initialization:
+
+    person = Person.new('Bruce', 'Williams')
+    person.shorthand do
+      location 'Portland, OR'
+      zipcode '97209'
+    end
+
+Want to one use one or the other?  You can include the ala-carte
+modules `Shorthand::Init` or `Shorthand::Method` instead.
+
+Want to give the `shorthand` method another name (like `configure`)?
+Have at it with `alias` and `alias_method`.
+
+Copyright
+---------
+
+Copyright (c) 2010 Bruce Williams. See LICENSE for details.
+
+

data/Rakefile

@@ -0,0 +1,53 @@
+require 'rubygems'
+require 'rake'
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gem|
+    gem.name = "shorthand"
+    gem.summary = %Q{Externalize object-focused DSLs on attribute writers}
+    gem.description = %Q{This provides an easy way to build simple configuration-style DSLs and run them 'sandboxed' outside the instances they configure.}
+    gem.email = "bruce@codefluency.com"
+    gem.homepage = "http://github.com/bruce/shorthand"
+    gem.authors = ["Bruce Williams"]
+    gem.add_development_dependency "shoulda", ">= 0"
+    # gem is a Gem::Specification... see http://www.rubygems.org/read/chapter/20 for additional settings
+  end
+  Jeweler::GemcutterTasks.new
+rescue LoadError
+  puts "Jeweler (or a dependency) not available. Install it with: gem install jeweler"
+end
+
+require 'rake/testtask'
+Rake::TestTask.new(:test) do |test|
+  test.libs << 'lib' << 'test'
+  test.pattern = 'test/**/test_*.rb'
+  test.verbose = true
+end
+
+begin
+  require 'rcov/rcovtask'
+  Rcov::RcovTask.new do |test|
+    test.libs << 'test'
+    test.pattern = 'test/**/test_*.rb'
+    test.verbose = true
+  end
+rescue LoadError
+  task :rcov do
+    abort "RCov is not available. In order to run rcov, you must: sudo gem install rcov"
+  end
+end
+
+task :test => :check_dependencies
+
+task :default => :test
+
+require 'rake/rdoctask'
+Rake::RDocTask.new do |rdoc|
+  version = File.exist?('VERSION') ? File.read('VERSION') : ""
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "shorthand #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/VERSION

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

data/lib/shorthand.rb

@@ -0,0 +1,45 @@
+module Shorthand
+
+  def self.included(target_class)
+    target_class.instance_eval do
+      include Init
+      include Method
+    end
+  end
+
+  module Init
+    def initialize(*args, &block)
+      super
+      if block
+        ::Shorthand::Provider.new(self, &block)
+      end
+    end
+  end
+
+  module Method
+    def shorthand(&block)
+      if block
+        ::Shorthand::Provider.new(self, &block)
+      end
+    end
+  end
+  
+  class Provider
+    def initialize(target, &block)
+      @target = target
+      if block.arity == 1
+        yield self
+      else
+        instance_eval(&block)
+      end
+    end
+    def method_missing(meth, *args, &block)
+      if @target.respond_to?(message = "#{meth}=", true)
+        @target.__send__(message, *args, &block)
+      else
+        super
+      end
+    end
+  end
+
+end

data/test/helper.rb

@@ -0,0 +1,10 @@
+require 'rubygems'
+require 'test/unit'
+require 'shoulda'
+
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+require 'shorthand'
+
+class Test::Unit::TestCase
+end

data/test/test_shorthand.rb

@@ -0,0 +1,63 @@
+require 'helper'
+
+class TestShorthand < Test::Unit::TestCase
+
+  context 'instances of classes including Shorthand' do
+    setup do
+      @klass = Class.new do
+        include Shorthand
+        attr_accessor :foo
+      end
+    end
+
+    context "using the shorthand method" do
+      subject do
+        @klass.new
+      end
+      should 'have an method named shorthand' do
+        assert subject.respond_to?(:shorthand)
+      end
+      context 'when calling the writer in shorthand with instance_eval semantics' do
+        setup do
+          subject.shorthand { foo 1 }
+        end
+        should_change 'assigned value', :from => nil, :to => 1 do
+          subject.foo
+        end
+      end
+      context 'when calling the writer in shorthand with yield semantics' do
+        setup do
+          subject.shorthand { |s| s.foo 1 }
+        end
+        should_change 'assigned value', :from => nil, :to => 1 do
+          subject.foo
+        end
+      end
+    end
+    context "initializing with a block" do
+      context 'with instance_eval semantics' do
+        subject do
+          @klass.new { foo 1 }
+        end
+        should 'set foo' do
+          assert_equal 1, subject.foo
+        end
+      end
+      context 'with yield semantics' do
+        subject do
+          @klass.new { |f| f.foo 1 }
+        end
+        should 'set foo' do
+          assert_equal 1, subject.foo
+        end
+      end
+    end
+
+    private
+
+    def shorthand(&block)
+      subject.shorthand(&block)
+    end
+
+  end
+end

metadata

@@ -0,0 +1,83 @@
+--- !ruby/object:Gem::Specification 
+name: shorthand
+version: !ruby/object:Gem::Version 
+  prerelease: false
+  segments: 
+  - 0
+  - 1
+  - 0
+  version: 0.1.0
+platform: ruby
+authors: 
+- Bruce Williams
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-05-18 00:00:00 -07:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: shoulda
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id001
+description: This provides an easy way to build simple configuration-style DSLs and run them 'sandboxed' outside the instances they configure.
+email: bruce@codefluency.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE
+- README.md
+files: 
+- .document
+- .gitignore
+- LICENSE
+- README.md
+- Rakefile
+- VERSION
+- lib/shorthand.rb
+- test/helper.rb
+- test/test_shorthand.rb
+has_rdoc: true
+homepage: http://github.com/bruce/shorthand
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.6
+signing_key: 
+specification_version: 3
+summary: Externalize object-focused DSLs on attribute writers
+test_files: 
+- test/helper.rb
+- test/test_shorthand.rb