maiha-dsl_accessor 0.2

data/README

@@ -0,0 +1,131 @@
+DslAccessor
+===========
+
+This plugin gives hybrid accessor class methods to classes by DSL like definition,
+here hybrid means getter and setter. The accessor method acts as getter method
+if no argments given, otherwise it acts as setter one with the arguments.
+
+
+Usage
+=====
+
+  class Foo
+    dsl_accessor "<METHOD NAME>"
+  end
+
+
+Example
+=======
+
+  class Foo
+    dsl_accessor :greeting
+  end
+
+This code gives 'greeting' class method to Foo class.
+
+  Foo.greeting                 # means getter, and the default value is nil.
+  => nil
+
+  Foo.greeting "I'm Foo."      # means setter with given arguments
+  => "I'm Foo."
+
+  Foo.greeting
+  => "I'm Foo."
+
+
+Difference
+==========
+
+I'm convinced that you want to propose me to use 'cattr_accessor'.
+Although the difference is just whether we needs '=' operation or not,
+it makes a large different on class definition especially subclass.
+
+  class Foo
+    cattr_accessor :greeting
+  end
+
+  class Bar < Foo
+    self.greeting = "I'm bar."
+  end
+
+We must write redundant code represented by "self." to distinguish
+a local variable and a class method when we use 'cattr_accessor'.
+This is ugly and boring work.
+
+  class Foo
+    dsl_accessor :greeting
+  end
+
+  class Bar < Foo
+    greeting "I'm bar."
+  end
+
+There are no longer redundant prefix code like "self." and "set_".
+Don't you like this dsl-like coding with simple declaration?
+
+
+Special Options
+===============
+
+'dsl_accessor' method can take two options, those are :writer and :default.
+"writer" option means callback method used when setter is executed.
+"default" option means default static value or proc that creates some value.
+
+  class PseudoAR
+    dsl_accessor :primary_key, :default=>"id", :writer=>proc{|value| value.to_s}
+    dsl_accessor :table_name,  :default=>proc{|klass| klass.name.demodulize.underscore.pluralize}
+  end
+
+  class Item < PseudoAR
+  end
+
+  class User < PseudoAR
+    primary_key :user_code
+    table_name  :user_table
+  end
+
+  Item.primary_key  # => "id"
+  Item.table_name   # => "items"
+  User.primary_key  # => "user_code"
+  User.table_name   # => :user_table
+
+Note that "User.primary_key" return a String by setter proc.
+
+
+Instance Method
+===============
+
+"instance" option automatically defines its instance method
+
+  class Search
+    dsl_accessor :url, :instance=>true, :default=>"http://localhost/"
+  end
+
+  Search.url       # => "http://localhost/"
+  Search.new.url   # => "http://localhost/"
+
+and it uses @options instance variable with special value :options
+
+  class Window
+    dsl_accessor :width, :default=>640, :instance=>:options
+    def initialize(options = {})
+      @options = options
+    end
+  end
+
+  Window.width       # => 640
+  Window.new.width   # => 640
+
+  window = Window.new(:width=>320)
+  window.width       # =>320
+
+
+Install
+=======
+
+ git://github.com/maiha/dsl_accessor.git  
+
+
+Author
+======
+Maiha <anna@wota.jp>

data/Rakefile

@@ -0,0 +1,22 @@
+require 'rake'
+require 'rake/testtask'
+require 'rake/rdoctask'
+
+desc 'Default: run unit tests.'
+task :default => :test
+
+desc 'Test the dsl_accessor plugin.'
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'lib'
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = true
+end
+
+desc 'Generate documentation for the dsl_accessor plugin.'
+Rake::RDocTask.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'DslAccessor'
+  rdoc.options << '--line-numbers' << '--inline-source'
+  rdoc.rdoc_files.include('README')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/core_ext/class/dsl_accessor.rb

@@ -0,0 +1,71 @@
+class Class
+  def dsl_accessor(name, *args)
+    options = args.last.is_a?(Hash) ? args.pop : {}
+    options[:default] = args.shift unless args.empty?
+
+    case options[:instance]
+    when nil
+      # nop
+    when :options
+      module_eval(<<-EOS, "(__DSL_ACCESSOR__)", 1)
+        def #{ name }
+          unless @options
+            raise TypeError, "DSL Error: missing @options for %s##{name}" % self.class.name
+          end
+          @options[:#{ name }] || self.class.#{ name }
+        end
+      EOS
+    when true
+      delegate name, :to=>"self.class"
+    else
+      raise TypeError, "DSL Error: :instance should be true or :instance, but got `%s' class" % options[:instance].class
+    end
+
+    raise TypeError, "DSL Error: options should be a hash. but got `#{options.class}'" unless options.is_a?(Hash)
+    writer = options[:writer] || options[:setter]
+    writer =
+      case writer
+      when NilClass then Proc.new{|value| value}
+      when Symbol   then Proc.new{|value| __send__(writer, value)}
+      when Proc     then writer
+      else raise TypeError, "DSL Error: writer should be a symbol or proc. but got `#{options[:writer].class}'"
+      end
+    write_inheritable_attribute(:"#{name}_writer", writer)
+
+    default =
+      case options[:default]
+      when NilClass then nil
+      when []       then Proc.new{[]}
+      when {}       then Proc.new{{}}
+      when Symbol   then Proc.new{__send__(options[:default])}
+      when Proc     then options[:default]
+      else Proc.new{options[:default]}
+      end
+    write_inheritable_attribute(:"#{name}_default", default)
+
+    (class << self; self end).class_eval do
+      define_method("#{name}=") do |value|
+        writer = read_inheritable_attribute(:"#{name}_writer")
+        value  = writer.call(value) if writer
+        write_inheritable_attribute(:"#{name}", value)
+      end
+
+      define_method(name) do |*values|
+        if values.empty?
+          # getter method
+          key = :"#{name}"
+          if !inheritable_attributes.has_key?(key)
+            default = read_inheritable_attribute(:"#{name}_default")
+            value   = default ? default.call(self) : nil
+            __send__("#{name}=", value)
+          end
+          read_inheritable_attribute(key)
+        else
+          # setter method
+          __send__("#{name}=", *values)
+        end
+      end
+    end
+  end
+end
+

data/init.rb

@@ -0,0 +1,3 @@
+
+require File.dirname(__FILE__) + '/core_ext/class/dsl_accessor'
+

data/install.rb

@@ -0,0 +1 @@
+# Install hook code here

data/lib/dsl_accessor.rb

@@ -0,0 +1 @@
+# DslAccessor

data/tasks/dsl_accessor_tasks.rake

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

data/test/default_test.rb

@@ -0,0 +1,64 @@
+require File.dirname(__FILE__) + '/test_helper'
+
+
+class DslDefaultAccessorTest < Test::Unit::TestCase
+
+  class CoolActiveRecord
+    dsl_accessor :primary_key, :default=>"id"
+    dsl_accessor :table_name,  :default=>proc{|klass| klass.name.demodulize.underscore.pluralize}
+  end
+
+  class Item < CoolActiveRecord
+  end
+
+  class User < CoolActiveRecord
+  end
+
+  class Folder
+    dsl_accessor :array_folder, :default=>[]
+    dsl_accessor :hash_folder,  :default=>{}
+  end
+
+  class SubFolder < Folder
+  end
+
+  def test_default_accessor_with_string
+    assert_equal "id", Item.primary_key
+    assert_equal "id", User.primary_key
+  end
+
+  def test_default_accessor_with_proc
+    assert_equal "items", Item.table_name
+    assert_equal "users", User.table_name
+  end
+
+  def test_default_accessor_should_duplicate_empty_array_or_hash
+    Folder.array_folder << 1
+    Folder.hash_folder[:name] = "maiha"
+
+    assert_equal([1], Folder.array_folder)
+    assert_equal({:name=>"maiha"}, Folder.hash_folder)
+
+    assert_equal([], SubFolder.array_folder)
+    assert_equal({}, SubFolder.hash_folder)
+  end
+end
+
+
+class DslOverwritenDefaultAccessorTest < Test::Unit::TestCase
+  class CoolActiveRecord
+    dsl_accessor :primary_key, :default=>"id"
+    dsl_accessor :table_name,  :default=>proc{|klass| klass.name.demodulize.underscore.pluralize}
+  end
+
+  class Item < CoolActiveRecord
+    primary_key :item_id
+    table_name  :item_table
+  end
+
+  def test_overwrite_default_accessor
+    assert_equal :item_id,    Item.primary_key
+    assert_equal :item_table, Item.table_name
+  end
+end
+

data/test/dsl_accessor_test.rb

@@ -0,0 +1,47 @@
+require File.dirname(__FILE__) + '/test_helper'
+
+
+class DslAccessorTest < Test::Unit::TestCase
+  class CoolActiveRecord
+    dsl_accessor :primary_key
+    dsl_accessor :table_name
+  end
+
+  class Item < CoolActiveRecord
+  end
+
+  class LegacyItem < CoolActiveRecord
+    primary_key :itcd
+    table_name  :item
+  end
+
+  class OtherClass
+  end
+
+  def test_dsl_accessor_doesnt_affect_other_classes
+    assert !OtherClass.respond_to?(:primary_key)
+  end
+
+  def test_accessor_without_initialization
+    assert_equal nil, Item.primary_key
+    assert_equal nil, Item.table_name
+
+    Item.primary_key :itcd
+    Item.table_name  :item
+
+    assert_equal :itcd, Item.primary_key
+    assert_equal :item, Item.table_name
+  end
+
+  def test_accessor_with_initialization
+    assert_equal :itcd, LegacyItem.primary_key
+    assert_equal :item, LegacyItem.table_name
+
+    LegacyItem.primary_key :item_id
+    LegacyItem.table_name  :item_table
+
+    assert_equal :item_id,    LegacyItem.primary_key
+    assert_equal :item_table, LegacyItem.table_name
+  end
+end
+

data/test/instance_options_test.rb

@@ -0,0 +1,38 @@
+require File.dirname(__FILE__) + '/test_helper'
+
+class DefineInstanceMethodWithOptionsTest < Test::Unit::TestCase
+  class Window
+    dsl_accessor :width, :default=>640, :instance=>:options
+  end
+
+  class OptionedWindow
+    dsl_accessor :width, :default=>640, :instance=>:options
+    def initialize(options = {})
+      @options = options
+    end
+  end
+
+  def test_class_method
+    assert_equal Window.width, 640
+    assert_equal OptionedWindow.width, 640
+  end
+
+  def test_instance_method
+    assert_raises(TypeError) { Window.new.width }
+    assert_equal OptionedWindow.new.width, 640
+  end
+
+  def test_use_options_variable_rather_than_default_value
+    window = OptionedWindow.new( :width => 320 )
+    assert_equal window.width, 320
+  end
+
+  def test_instance_options_value_doesnt_affect_to_class_method
+    window = OptionedWindow.new( :width => 320 )
+    assert_equal OptionedWindow.width, 640
+  end
+
+end
+
+
+

data/test/instance_test.rb

@@ -0,0 +1,43 @@
+require File.dirname(__FILE__) + '/test_helper'
+
+class DefineInstanceMethodTest < Test::Unit::TestCase
+  class Item
+    dsl_accessor :primary_key, "code", :instance=>true
+  end
+
+  class OtherClass
+  end
+
+  def test_dsl_accessor_doesnt_affect_other_classes
+    assert !OtherClass.respond_to?(:primary_key)
+  end
+
+  def test_dsl_accessor_doesnt_affect_other_instances
+    assert !OtherClass.new.respond_to?(:primary_key)
+  end
+
+  def test_class_method
+    assert Item.respond_to?(:primary_key)
+    assert_nothing_raised do
+      Item.primary_key
+    end
+  end
+
+  def test_class_method_value
+    assert_equal "code", Item.primary_key
+  end
+
+  def test_instance_method
+    assert Item.new.respond_to?(:primary_key)
+    assert_nothing_raised do
+      Item.new.primary_key
+    end
+  end
+
+  def test_instance_method_value
+    assert_equal "code", Item.new.primary_key
+  end
+end
+
+
+

data/test/test_helper.rb

@@ -0,0 +1,14 @@
+require 'test/unit'
+
+def __DIR__; File.dirname(__FILE__); end
+
+begin
+  require 'rubygems'
+  require 'active_support'
+rescue LoadError
+  $:.unshift(__DIR__ + '/../../../rails/activesupport/lib')
+  require 'active_support'
+end
+
+require File.dirname(__FILE__) + '/../init'
+

data/test/writer_test.rb

@@ -0,0 +1,21 @@
+require File.dirname(__FILE__) + '/test_helper'
+
+
+class DslWriterAccessorTest < Test::Unit::TestCase
+  class Item
+    dsl_accessor :primary_key, :writer=>proc{|value| value.to_s}
+  end
+
+  def test_string_writer
+    assert_equal "", Item.primary_key
+
+    Item.primary_key :id
+    assert_equal "id", Item.primary_key
+
+    Item.primary_key "id"
+    assert_equal "id", Item.primary_key
+  end
+end
+
+
+

metadata

@@ -0,0 +1,65 @@
+--- !ruby/object:Gem::Specification 
+name: maiha-dsl_accessor
+version: !ruby/object:Gem::Version 
+  version: "0.2"
+platform: ruby
+authors: 
+- maiha
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2008-06-02 00:00:00 -07:00
+default_executable: 
+dependencies: []
+
+description: ""
+email: maiha@wota.jp
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- README
+- Rakefile
+- core_ext/class/dsl_accessor.rb
+- init.rb
+- install.rb
+- lib/dsl_accessor.rb
+- tasks/dsl_accessor_tasks.rake
+- test/default_test.rb
+- test/dsl_accessor_test.rb
+- test/instance_options_test.rb
+- test/instance_test.rb
+- test/test_helper.rb
+- test/writer_test.rb
+has_rdoc: true
+homepage: http://github.com/maiha/dsl_accessor
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.0.1
+signing_key: 
+specification_version: 2
+summary: ""
+test_files: []
+