dsl_accessor 0.1.0

data/Manifest.txt

@@ -0,0 +1,9 @@
+History.txt
+Manifest.txt
+README.txt
+Rakefile
+setup.rb
+lib/dsl_accessor.rb
+lib/dsl_accessor/version.rb
+test/test_helper.rb
+test/dsl_accessor_test.rb

data/README.txt

@@ -0,0 +1,97 @@
+= DslAccessor
+
+This gem 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 arguments 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.
+
+
+=== Install
+
+  gem install dsl_accessor
+
+=== Author
+
+Code: Maiha <anna@wota.jp>
+Gem: Alex Wayne <rubyonrails@beautifulpixel.com>

data/Rakefile

@@ -0,0 +1,49 @@
+require 'rubygems'
+require 'rake'
+require 'rake/clean'
+require 'rake/testtask'
+require 'rake/packagetask'
+require 'rake/gempackagetask'
+require 'rake/rdoctask'
+require 'rake/contrib/rubyforgepublisher'
+require 'fileutils'
+require 'hoe'
+include FileUtils
+require File.join(File.dirname(__FILE__), 'lib', 'dsl_accessor', 'version')
+
+AUTHOR = ['Maiha', 'Alex Wayne']  # can also be an array of Authors
+EMAIL = "anna@wota.jp"
+DESCRIPTION = "This gem gives hybrid accessor class methods to classes by DSL like definition."
+GEM_NAME = "dsl_accessor"
+RUBYFORGE_PROJECT = "dsl-accessor"
+HOMEPATH = "http://#{RUBYFORGE_PROJECT}.rubyforge.org"
+RELEASE_TYPES = %w( gem )
+
+
+NAME = "dsl_accessor"
+REV = nil # UNCOMMENT IF REQUIRED: File.read(".svn/entries")[/committed-rev="(d+)"/, 1] rescue nil
+VERS = ENV['VERSION'] || (DslAccessor::VERSION::STRING + (REV ? ".#{REV}" : ""))
+CLEAN.include ['**/.*.sw?', '*.gem', '.config']
+RDOC_OPTS = ['--quiet', '--title', "dsl_accessor documentation",
+    "--opname", "index.html",
+    "--line-numbers", 
+    "--main", "README",
+    "--inline-source"]
+
+# Generate all the Rake tasks
+# Run 'rake -T' to see list of generated tasks (from gem root directory)
+hoe = Hoe.new(GEM_NAME, VERS) do |p|
+  p.author = AUTHOR 
+  p.description = DESCRIPTION
+  p.email = EMAIL
+  p.summary = DESCRIPTION
+  p.url = HOMEPATH
+  p.rubyforge_name = RUBYFORGE_PROJECT if RUBYFORGE_PROJECT
+  p.test_globs = ["test/**/*_test.rb"]
+  p.clean_globs = CLEAN  #An array of file patterns to delete on clean.
+  
+  # == Optional
+  #p.changes        - A description of the release's latest changes.
+  p.extra_deps = %w( activesupport )
+  #p.spec_extras    - A hash of extra values to set in the gemspec.
+end

data/lib/dsl_accessor/version.rb

@@ -0,0 +1,9 @@
+module DslAccessor #:nodoc:
+  module VERSION #:nodoc:
+    MAJOR = 0
+    MINOR = 1
+    TINY  = 0
+
+    STRING = [MAJOR, MINOR, TINY].join('.')
+  end
+end

data/lib/dsl_accessor.rb

@@ -0,0 +1,52 @@
+require 'active_support'
+
+class Class
+  def dsl_accessor(name, options = {})
+    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)
+
+    self.class.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
+