auser-dslify 0.0.7 → 0.1.0

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2009 Ari Lerner
+
+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,33 @@
+= dslify
+
+Dslify, born out of a need for improvement on Dslify
+
+Add dsl accessors to any class.
+
+Usage:
+  class MyClass
+    include Dslify
+    
+    dsl_methods :award, :people
+  end
+  
+  mc = MyClass.new
+  mc.award "Tony Award"
+  mc.people ["Bob", "Frank", "Ben"]
+  
+You can set defaults as well:
+  class MyClass
+    default_options :award => "Tony Award"
+  end
+
+Finally, if your tree of available accessors runs higher and longer than
+just 1 file, for instance, if you use Parenting, you can set forwarders to 
+forward the query up the chain
+
+class MyClass
+  forwards_to :parent
+end
+
+== Copyright
+
+Copyright (c) 2009 Ari Lerner. See LICENSE for details.

data/VERSION.yml

@@ -0,0 +1,4 @@
+--- 
+:major: 0
+:minor: 1
+:patch: 0

data/lib/dslify.rb

@@ -1,7 +1,78 @@
-$:.unshift(File.dirname(__FILE__)) unless
-  $:.include?(File.dirname(__FILE__)) || $:.include?(File.expand_path(File.dirname(__FILE__)))
-
-Dir["#{File.dirname(__FILE__)}/dslify/*.rb"].each {|f| require f }
-
 module Dslify
+  def self.included(base)
+    base.send     :include, InstanceMethods
+    base.extend(ClassMethods)
+  end
+  
+  module ClassMethods    
+    def default_options(hsh={})
+      (@_dsl_options ||= {}).merge! hsh
+      set_default_options(@_dsl_options)
+    end
+    
+    def dsl_options
+      @_dsl_options ||= {}
+    end
+    def options
+      dsl_options
+    end
+    
+    def dsl_methods(*syms)
+      syms.each {|sym| set_default_options({sym => nil}) }
+    end
+    
+    def set_default_options(new_options)
+      new_options.each do |k,v|
+        dsl_options[k] = v
+        class_eval define_dsl_method_str(k)
+      end
+    end
+    
+    def define_dsl_method_str(k)
+      <<-EOE
+        def #{k}(n=nil)
+          if n.nil?
+            fetch(:#{k})
+          else
+            self.#{k}=n
+          end          
+        end
+        def #{k}=(n)
+          dsl_options[:#{k}] = n
+        end
+        def fetch(k)
+          dsl_options[k]                    
+        end
+      EOE
+    end
+    
+    def inherited(subclass)
+      subclass.set_default_options(dsl_options)
+    end
+  end
+  module InstanceMethods
+    def dsl_options
+      @dsl_options ||= self.class.dsl_options.clone
+    end
+    def set_vars_from_options(hsh={})
+      hsh.each do |k,v| 
+        instance_eval self.class.define_dsl_method_str(k) unless self.respond_to?(k)
+        self.send k, v
+      end
+    end
+    
+    def set_default_options(hsh={})
+      self.class.set_default_options(hsh)
+    end
+    
+    def method_missing(m,*a,&block)
+      if m.to_s[-1..-1] == '?'
+        t = m.to_s.gsub(/\?/, '').to_sym
+        warn "DEPRECATED: Dslify will no longer support ? methods. Fix yo code.: #{m}"
+        respond_to?(t) && !self.send(t, *a, &block).nil?
+      else
+        super
+      end
+    end
+  end
 end

data/test/dslify_test.rb

@@ -0,0 +1,232 @@
+require "#{File.dirname(__FILE__)}/test_helper"
+
+class Quickie
+  include Dslify
+  def initialize(&block)
+    instance_eval &block if block
+  end
+end
+
+class QuickieTest < Test::Unit::TestCase
+  context "setting" do
+    before do
+      Quickie.class_eval do
+        dsl_methods :bank, :snobs, :author, :gilligans_island
+      end
+      @q = Quickie.new
+    end
+    it "should be able to set methods on self" do
+      assert_nothing_raised do
+        @q.bank "bobs"
+      end
+    end
+    it "should set and then retrieve the same value back" do
+      @q.snobs "are mean"
+      assert_equal @q.snobs, "are mean"
+    end
+    it "should set and retrieve values back with an = sign" do
+      @q.author = ["Ari Lerner"]
+      assert_equal @q.author, ["Ari Lerner"]
+    end
+    it "should set these values in the h Hash on the object" do
+      assert_raise NoMethodError do
+        @q.movies "can be fun"
+      end
+    end
+    it "should set multiple keys with set_vars_from_options" do
+      @q.set_vars_from_options({:a => "a", :b => "b"})
+      assert_equal @q.a, "a"
+      assert_equal @q.b, "b"
+    end
+    it "should set methods even when they are called with a block" do
+      @q.author Quickie.new do
+      end
+      assert_equal @q.author.class, Quickie
+    end
+  end
+  
+  context "calling methods on an instance" do
+    setup do
+      class Detective
+        include Dslify
+        attr_reader :snooped
+        def snoop(*n)
+          @snooped = "done!"
+        end
+      end
+      @d= Detective.new
+    end
+    should "Call the method snoop with set_vars_from_options" do
+      @d.set_vars_from_options(:snoop => true)
+      assert @d.snooped
+    end
+  end
+  
+  context "default options" do
+    setup do
+      class Bang
+        include Dslify
+        default_options(
+          :says => 'vmrun'
+        )
+        def initialize(opts={}, &block)
+          instance_eval &block if block
+        end
+      end
+      @bang = Bang.new
+    end
+
+    should "overwrite the default dsl option in instance_eval" do
+      assert_equal @bang.says, "vmrun"
+      @bang = Bang.new do
+        says "snake"
+      end
+      assert_equal @bang.says, "snake"
+    end
+  end
+  
+  
+  context "with inheritance and classes" do
+    before do
+      class Pop
+        include Dslify
+        default_options :name => "pop", :flavor=>'cherry'
+        def initialize(o={})
+          set_vars_from_options(o)
+        end
+        
+        def real_method
+          "the real deal, no magic"
+        end
+      end
+      
+      class Foo < Pop
+        default_options :name=>'fooey'
+      end
+      
+      class Bar < Pop
+        default_options :name=>'pangy', :taste => "spicy"
+      end
+      
+      class Dad < Pop
+      end
+      
+      class Grandad < Dad
+      end
+      
+      class Defaults < Pop
+        default_options(
+          :global_default => "red_rum"
+        )
+      end
+      
+      @pop = Pop.new      
+      @foo = Foo.new
+      @bar = Bar.new
+    end
+    it "should take the default options set on the class" do
+      assert_equal @pop.dsl_options[:name], "pop"
+      assert_equal @pop.name, "pop"
+    end
+    it "should allow us to add defaults on the instance by calling dsl_options" do      
+      # QuickieTest::Pop.name == "Cinnamon"
+      @poptart = Pop.new :name => "Cinnamon"
+      assert_equal @poptart.name, "Cinnamon"
+    end
+    it "should take the default options on a second class that inherits from the base" do
+      assert_equal @foo.name, "fooey"
+    end
+    it "should take the default options on a third inheriting class" do
+      assert_equal @bar.name, "pangy"
+    end
+    it "should not add a method not in the default_options" do
+      assert_equal @bar.respond_to?(:boat), false      
+    end
+    it "should return the original default options test" do
+      assert_equal @bar.dsl_options[:taste], "spicy"
+      assert_equal @bar.dsl_options[:name], "pangy"
+    end
+    it "should set the default options of the child to the superclass's if it doesn't exist" do
+      # QuickieTest::Dad => QuickieTest::Pop
+      d = Dad.new
+      assert Pop.new.name == 'pop'
+      assert_equal "pop", d.name
+      d.name "Frankenstein"
+      assert_equal d.name, "Frankenstein"
+    end
+    it "should raise if the method isn't found on itself, the parent or in the rest of the method missing chain" do
+      assert_raise NoMethodError do
+        Class.new.sanitorium
+      end
+    end
+    it "should be able to reach the grandparent through the chain of dsify-ed classes" do
+      # QuickieTest::Grandad => QuickieTest::Dad => QuickieTest::Pop
+      assert Dad.method_defined?(:name)
+      assert Dad.new.flavor == 'cherry'
+      assert Grandad.new.name, "pop"
+    end
+    # it "should be able to take a method that responds to an object" do
+    #   class Tanks
+    #     include Dslify
+    #     forwards_to :parent
+    #     def initialize(obj)
+    #       @parent = obj
+    #     end
+    #     def parent          
+    #       @parent
+    #     end
+    #   end
+    #   t = Tanks.new(@bar)
+    #   # QuickieTest::Tanks => Object => #<QuickieTest::Bar>
+    #   assert_equal t.taste, @bar.taste
+    # end
+  end
+  context "methods" do
+    setup do
+      class MrDanger
+        include Dslify
+        default_options :where_to => "The Grand Canyon"
+        def initialize(o={})
+          set_vars_from_options(o)
+        end
+        def where_to(*a)
+          "New York City"
+        end
+      end
+    end
+
+    should "not override the method where_to" do
+      assert_equal MrDanger.new.where_to, "New York City"
+    end
+    should "not override the method where_to when called with set_vars_from_options" do
+      assert_equal MrDanger.new(:where_to => "Bank of America").where_to, "New York City"
+    end
+  end
+  
+  context "when calling with a block" do
+    setup do
+      class ToddTheSquare
+        include Dslify
+        default_options :provider => :vmrun, :t => :nothing
+        
+        def provider(&block)
+          instance_eval &block if block
+        end
+      end
+    end
+    
+    should "should not evaluate the block" do
+      tts = ToddTheSquare.new
+      assert_equal tts.t, :nothing
+    end
+
+    should "should evaluate the block" do
+      tts = ToddTheSquare.new
+      tts.provider do
+        self.t = :something
+      end
+      assert_equal tts.t, :something
+    end
+  end
+  
+end

data/test/test_helper.rb

@@ -0,0 +1,7 @@
+require 'rubygems'
+require 'test/unit'
+require 'shoulda'
+require "context"
+
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+require 'dslify'

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: auser-dslify
 version: !ruby/object:Gem::Version 
-  version: 0.0.7
+  version: 0.1.0
 platform: ruby
 authors: 
 - Ari Lerner
@@ -9,69 +9,32 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-04-29 00:00:00 -07:00
+date: 2009-05-14 00:00:00 -07:00
 default_executable: 
-dependencies: 
-- !ruby/object:Gem::Dependency 
-  name: hoe
-  type: :development
-  version_requirement: 
-  version_requirements: !ruby/object:Gem::Requirement 
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        version: 1.8.0
-    version: 
-description: Easily add DSL-like calls to any class
-email: 
-- arilerner@mac.com
+dependencies: []
+
+description: 
+email: arilerner@mac.com
 executables: []
 
 extensions: []
 
 extra_rdoc_files: 
-- History.txt
-- Manifest.txt
-- PostInstall.txt
-- README.txt
-- website/index.txt
+- README.rdoc
+- LICENSE
 files: 
-- History.txt
-- Manifest.txt
-- PostInstall.txt
-- README.txt
-- Rakefile
-- config/hoe.rb
-- config/requirements.rb
-- dslify.gemspec
+- README.rdoc
+- VERSION.yml
 - lib/dslify.rb
-- lib/dslify/dslify.rb
-- lib/dslify/version.rb
-- script/console
-- script/destroy
-- script/generate
-- script/txt2html
-- setup.rb
-- tasks/deployment.rake
-- tasks/environment.rake
-- tasks/website.rake
-- test/test_dslify.rb
-- website/index.html
-- website/index.txt
-- website/javascripts/rounded_corners_lite.inc.js
-- website/stylesheets/screen.css
-- website/template.html.erb
+- test/dslify_test.rb
+- test/test_helper.rb
+- LICENSE
 has_rdoc: true
-homepage: http://dslify.rubyforge.org
-post_install_message: |-
-  Thanks for installing dslify!
-  
-  For more information on dslify, see http://dslify.rubyforge.org
-  
-  Ari Lerner
+homepage: http://github.com/auser/dslify
+post_install_message: 
 rdoc_options: 
-- --main
-- README.txt
+- --inline-source
+- --charset=UTF-8
 require_paths: 
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement 
@@ -88,10 +51,10 @@ required_rubygems_version: !ruby/object:Gem::Requirement
   version: 
 requirements: []
 
-rubyforge_project: dslify
+rubyforge_project: 
 rubygems_version: 1.2.0
 signing_key: 
 specification_version: 3
-summary: Easily add DSL-like calls to any class
-test_files: 
-- test/test_dslify.rb
+summary: TODO
+test_files: []
+