defined-by 0.0.5

data/MIT-LICENSE.markdown

@@ -0,0 +1,20 @@
+Copyright (c) 2010 Lance Pollard (lancejpollard@gmail.com)
+ 
+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.markdown

@@ -0,0 +1,45 @@
+# DefinedBy
+
+> Advanced DSL and Dynamic class generation for Ruby
+
+## When do I is this?
+
+- If you want to use a DSL to cut down on your code base
+- If you need that DSL to create classes
+- If you have a base class (e.g. `Widget`) and want to subclass it dozens of times but it's overkill to create separate classes for it manually.
+- Define template classes (default values for subclasses)
+    
+## All at once    
+    
+    class Widget
+      class << self
+        def define(&block)
+          DefinedBy::DSL(&block).map do |key, value, dsl_block|
+            define_class(key, self).new(:name => key.to_s, :description => value)
+          end
+        end
+      end
+      
+      attr_accessor :name, :description
+
+      def initialize(attributes = {})
+        attributes.each do |key, value|
+          self.send("#{key.to_s}=", value)
+        end
+      end
+    end
+    
+    def Widget(&block)
+      Widget.define(&block)
+    end
+
+    widgets = Widget do
+      widget_a "This widget does X"
+      widget_b "This does Y"
+    end
+
+    puts widgets.inspect
+    #=> [
+      #<WidgetA:0x5c3348 @description="This widget does X", @name="widget_a">,
+      #<WidgetB:0x5c2970 @description="This does Y", @name="widget_b">
+    ]

data/Rakefile

@@ -0,0 +1,78 @@
+require 'rake'
+require "rake/rdoctask"
+require 'rake/gempackagetask'
+
+spec = Gem::Specification.new do |s|
+  s.name              = "defined-by"
+  s.authors           = ["Lance Pollard"]
+  s.version           = "0.0.5"
+  s.summary           = "Advanced DSL and Dynamic class generation for Ruby"
+  s.homepage          = "http://github.com/viatropos/defined-by"
+  s.email             = "lancejpollard@gmail.com"
+  s.description       = "Advanced DSL and Dynamic class generation for Ruby"
+  s.has_rdoc          = false
+  s.rubyforge_project = "defined-by"
+  s.platform          = Gem::Platform::RUBY
+  s.files             = %w(README.markdown Rakefile MIT-LICENSE.markdown) + Dir["{lib,test}/**/*"] - Dir["test/tmp"]
+  s.require_path      = "lib"
+end
+
+Rake::GemPackageTask.new(spec) do |pkg|
+  pkg.gem_spec    = spec
+  pkg.package_dir = "pkg"
+end
+
+desc 'run unit tests'
+task :test do
+  Dir["test/**/*"].each do |file|
+    next unless File.basename(file) =~ /test_/
+    next unless File.extname(file) == ".rb"
+    system "ruby #{file}"
+  end
+end
+
+desc "Create .gemspec file (useful for github)"
+task :gemspec do
+  File.open("pkg/#{spec.name}.gemspec", "w") do |f|
+    f.puts spec.to_ruby
+  end
+end
+
+desc "Build the gem into the current directory"
+task :gem => :gemspec do
+  `gem build pkg/#{spec.name}.gemspec`
+end
+
+desc "Publish gem to rubygems"
+task :publish => [:package] do
+  %x[gem push pkg/#{spec.name}-#{spec.version}.gem]
+end
+
+desc "Print a list of the files to be put into the gem"
+task :manifest do
+  File.open("Manifest", "w") do |f|
+    spec.files.each do |file|
+      f.puts file
+    end
+  end
+end
+
+desc "Install the gem locally"
+task :install => [:package] do
+  File.mkdir("pkg") unless File.exists?("pkg")
+  command = "gem install pkg/#{spec.name}-#{spec.version} --no-ri --no-rdoc"
+  command = "sudo #{command}" if ENV["SUDO"] == true
+  sh %{#{command}}
+end
+
+desc "Generate the rdoc"
+Rake::RDocTask.new do |rdoc|
+  files = ["README.markdown", "lib/**/*.rb"]
+  rdoc.rdoc_files.add(files)
+  rdoc.main = "README.markdown"
+  rdoc.title = spec.summary
+end
+
+task :yank do
+  `gem yank #{spec.name} -v #{spec.version}`
+end

data/lib/defined-by.rb

@@ -0,0 +1,3 @@
+Dir["#{File.dirname(__FILE__)}/defined-by/*"].each do |file|
+  require file if File.extname(file) == ".rb"
+end

data/lib/defined-by/define_class.rb

@@ -0,0 +1,7 @@
+def define_class(name, superclass = Object, &block)
+  name = name.to_s.gsub(/\/(.?)/) { "::#{$1.upcase}" }.gsub(/(?:^|_)(.)/) { $1.upcase }
+  eval("class #{name} < #{superclass}; end")
+  clazz = eval(name)
+  clazz.class_eval(&block) if block_given?
+  clazz
+end

data/lib/defined-by/define_module.rb

@@ -0,0 +1,11 @@
+def define_module(name, &block)
+  name = name.to_s.gsub(/\/(.?)/) { "::#{$1.upcase}" }.gsub(/(?:^|_)(.)/) { $1.upcase }
+  parts = name.split("::")
+  parts.each_with_index do |part, index|
+    sub_name = parts[0..index].join("::")
+    eval("module #{sub_name}; end")
+  end
+  clazz = eval(name)
+  clazz.class_eval(&block) if block_given?
+  clazz
+end

data/lib/defined-by/dsl.rb

@@ -0,0 +1,35 @@
+module DefinedBy
+  class DSL
+    def initialize(&block)
+      @values = []
+      instance_eval(&block) if block_given?
+    end
+  
+    def <<(array)
+      @values << array
+    end
+  
+    def each(&block)
+      @values.each do |array|
+        yield(array[0], array[1], array[2])
+      end
+    end
+  
+    def map(&block)
+      @values.map do |array|
+        yield(array[0], array[1], array[2])
+      end
+    end
+  
+    def method_missing(method, *args, &block)
+      args = *args
+      self << [method.to_sym, args, block]
+    end
+  end
+
+  class << self
+    def DSL(&block)
+      DSL.new(&block)
+    end
+  end
+end

data/lib/defined-by/missing_constant.rb

@@ -0,0 +1,51 @@
+module DefinedBy
+  module MissingConstant
+    class Definition
+      class << self
+        attr_accessor :definitions
+        
+        def for(const_name)
+          definitions.detect do |definition|
+            definition.match(const_name)
+          end.constant rescue nil
+        end
+        
+        def definitions
+          @definitions ||= []
+        end
+        
+        def define!(&block)
+          DefinedBy::DSL(&block).each do |key, value, dsl_block|
+            definitions << Definition.new(value.first, value.last)
+          end
+        end
+      end
+      
+      attr_reader :pattern, :replacement, :constant
+      def initialize(pattern, replacement)
+        @pattern, @replacement = pattern, replacement
+      end
+      
+      def match(const_name)
+        if const_name.to_s.match(pattern)
+          @constant = const_name.to_s.gsub(pattern, replacement).to_sym
+        else
+          @constant = nil
+        end
+      end
+    end
+    
+#    def const_missing(const_name)
+#      if new_constant = Definition.for(const_name)
+#        super(new_constant)
+#      end
+#      super(const_name)
+#    end
+  end
+  
+  def self.MissingConstants(&block)
+    DefinedBy::MissingConstant::Definition.define!(&block)
+  end
+end
+
+#Class.instance_eval { include DefinedBy::MissingConstant }

data/test/lib/widget.rb

@@ -0,0 +1,27 @@
+class Widget
+  class << self
+    def define(&block)
+      DefinedBy::DSL(&block).map do |key, value, dsl_block|
+        define_class(key.to_s.camelize, self).class_eval <<-EOF
+          def initialize(attributes = {})
+            attributes[:name] ||= #{key.to_s.inspect}
+            attributes[:description] ||= #{value.to_s.inspect}
+            super(attributes)
+          end
+        EOF
+      end
+    end
+  end
+
+  attr_accessor :name, :description
+
+  def initialize(attributes = {})
+    attributes.each do |key, value|
+      self.send("#{key.to_s}=", value)
+    end
+  end
+end
+
+def Widget(&block)
+  Widget.define(&block)
+end

data/test/test_dsl.rb

@@ -0,0 +1,50 @@
+require File.join(File.dirname(__FILE__), 'test_helper')
+
+class DSLTest < ActiveSupport::TestCase
+  
+  context "DSL" do
+    
+    context "define widgets" do
+      setup do
+        widgets = Widget do
+          widget_a "This widget does X"
+          widget_b "This does Y"
+        end
+      end
+      
+      should "have 2 widget classes" do
+        assert WidgetA
+        assert WidgetB
+      end
+      
+      should "be able to instantiate the two widget classes" do
+        @a = WidgetA.new
+        @b = WidgetB.new
+        
+        assert @a
+        assert @b
+        
+        assert_equal "This widget does X", @a.description
+        assert_equal "This does Y", @b.description
+      end
+    end
+    
+  end
+  
+  context "Module" do
+    setup do
+      define_module("Lance::Pollard") do
+        class << self
+          def acts_as_lance_pollard
+            "yep"
+          end
+        end
+      end
+    end
+    
+    should "have defined the modules" do
+      assert Lance::Pollard
+      assert_equal "yep", Lance::Pollard.acts_as_lance_pollard
+    end
+  end
+end

data/test/test_helper.rb

@@ -0,0 +1,18 @@
+require "rubygems"
+require "ruby-debug"
+gem 'test-unit'
+require "test/unit"
+require 'active_support'
+require 'active_support/test_case'
+require 'shoulda'
+require 'shoulda/active_record'
+require 'logger'
+
+this = File.expand_path(File.dirname(__FILE__))
+
+require File.expand_path(File.join(this, '/../lib/defined-by'))
+
+Dir["#{this}/lib/*"].each { |c| require c if File.extname(c) == ".rb" }
+
+ActiveSupport::TestCase.class_eval do
+end

data/test/test_missing_constant.rb

@@ -0,0 +1,62 @@
+require File.join(File.dirname(__FILE__), 'test_helper')
+
+class MissingConstantTest < ActiveSupport::TestCase
+  
+  context "MissingConstant" do
+    
+    should "not have the constant by default" do
+      assert ::UserProfile
+    end
+    
+    context "define the base" do
+      setup do
+        class ::Object
+          class << self
+            def profile(&block)
+              define_class("::#{self.name}Profile", "::Profile") do
+                attr_accessor :profile
+
+                def profile
+                  @profile ||= {}
+                end
+              end
+            end
+          end
+        end
+
+        class ::Profile
+          
+        end
+      end
+      
+      should "have defined the profile" do
+        
+      end
+      
+      context "define the meat" do
+        setup do
+          class ::User
+            profile
+          end
+        end
+        
+        should "have defined the constant now" do
+          assert ::UserProfile
+        end
+      end
+    end
+    
+    context "DSL" do
+      setup do
+        DefinedBy::MissingConstants() do
+          match %r{\w+(Profile)$}, "\\1"
+        end
+      end
+      
+      should "define the dsl" do
+        assert_equal 1, DefinedBy::MissingConstant::Definition.definitions.length
+        assert_equal :Profile, DefinedBy::MissingConstant::Definition.for(:UserProfile)
+      end
+    end
+  end
+end

metadata

@@ -0,0 +1,79 @@
+--- !ruby/object:Gem::Specification 
+name: defined-by
+version: !ruby/object:Gem::Version 
+  hash: 21
+  prerelease: false
+  segments: 
+  - 0
+  - 0
+  - 5
+  version: 0.0.5
+platform: ruby
+authors: 
+- Lance Pollard
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-09-13 00:00:00 -05:00
+default_executable: 
+dependencies: []
+
+description: Advanced DSL and Dynamic class generation for Ruby
+email: lancejpollard@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- README.markdown
+- Rakefile
+- MIT-LICENSE.markdown
+- lib/defined-by/define_class.rb
+- lib/defined-by/define_module.rb
+- lib/defined-by/dsl.rb
+- lib/defined-by/missing_constant.rb
+- lib/defined-by.rb
+- test/lib/missing.rb
+- test/lib/widget.rb
+- test/test_dsl.rb
+- test/test_helper.rb
+- test/test_missing_constant.rb
+has_rdoc: true
+homepage: http://github.com/viatropos/defined-by
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: defined-by
+rubygems_version: 1.3.7
+signing_key: 
+specification_version: 3
+summary: Advanced DSL and Dynamic class generation for Ruby
+test_files: []
+