open_dsl 0.1

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2010 Envato, Ian Leitch.
+
+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,70 @@
+= Open DSL
+
+Open DSL is a DSL (Domain Specific Language) builder which aims to provide a highly readable DSL and the flexibility to integrate with existing Classes in your system. Open DSL uses OpenStructs internally when creating collections of attributes.. hence the name :)
+
+== Basic Example
+
+    open_dsl do
+        Finance do
+            tax do
+                rate "17.5%"
+            end
+        
+            accounts do
+                Account do
+                    name "earnings"
+                    withdrawal_limit 100_00
+                end
+            
+                Account do
+                    name "deposits"
+                    withdrawal_limit 0
+                end
+            end
+        end
+    end
+    
+Notice that Finance and Account start with an upper-case character, just like Ruby classes. This tells Open DSL that if an existing class with the same name exists then use it, otherwise a new class of that name will be created for you. This allows you to use Open DSL on classes that already exist in your system, the advantage of this is that you can use Open DSL as a way to configure a class whilst keeping business logic and functional code separate.
+
+In the case of Account, the class instance is assigned to the Finance instance with a name inferred from the Account class; an attribute named "account" is created which contains an instance of Account. "tax" will result in an OpenStruct being created and the "rate" attribute assigned. "accounts" is plural and therefore signifies an array containing each account.
+
+== Installing & Usage
+
+    gem install open_dsl
+
+    require 'rubygems'
+    require 'open_dsl'
+
+    open_dsl do
+    end
+or
+    OpenDsl::Builder.build do
+    end
+
+== Advanced Examples
+
+=== Explicit Attribute Names for Existing Classes
+
+If you have an existing class but like to assign it to an attribute with a different name or Open DSL fails to infer a nice name for it, you can explicity specify a name:
+
+    open_dsl do
+        configuration(MyConfigurationClass) do
+            value_1 "foo"
+            value_2 "bar"
+        end
+    end
+
+== Compatibility
+
+Tested with Ruby 1.8.7 only so far.
+
+== Contributions
+
+* Fork the project.
+* Make your feature addition or bug fix.
+* Add tests for it, specs live in the specs/ directory.
+* Commit and send me a pull request.
+
+== Copyright
+
+Copyright (c) 2010 Envato, Ian Leitch. See LICENSE for details.

data/lib/open_dsl/builder.rb

@@ -0,0 +1,35 @@
+module OpenDsl
+  class Builder
+    def self.build(file = nil, &blk)
+      builder = new(file, &blk)
+      builder.context.toplevel_object
+    end
+
+    def initialize(file = nil, &blk)
+      if file
+        build_from_file(file)
+      elsif blk
+        build_from_proc(blk)
+      else
+        raise "OpenDsl#new requires either a file to load or a block as an argument"
+      end
+    end
+
+    def context
+      @context
+    end
+
+    protected
+
+    def build_from_file(file)
+    end
+
+    def build_from_proc(blk)
+      instance_eval(&blk)
+    end
+
+    def method_missing(const_name, *args, &blk)
+      @context = Context.new(const_name, &blk)
+    end
+  end
+end

data/lib/open_dsl/context.rb

@@ -0,0 +1,92 @@
+module OpenDsl
+  class Context
+    include StringHelpers
+    attr_reader :toplevel_object
+
+    def initialize(const_name, &blk)
+      raise "Expected a constant name starting with an upper-case character, got '#{const_name}'" unless constant_or_constant_name?(const_name)
+      @toplevel_object = new_instance(const_name)
+      @stack = EvalStack.new(self)
+      @stack.eval_and_keep(@toplevel_object, &blk)
+    end
+
+    protected
+
+    def method_missing(name, *args, &blk)
+      # TODO: detect an internal error?
+
+      value = args.first
+      if constant_or_constant_name?(name)
+        assign_constant(name, &blk)
+      elsif blk
+        if constant_or_constant_name?(value)
+          assign_constant_to_explicit_attribute(name, value, &blk)
+        else
+          if plural?(name)
+            assign_collection(name, &blk)
+          else
+            assign_attribute_with_block(name, &blk)
+          end
+        end
+      else
+        assign_attribute(name, value)
+      end
+    end
+
+    def assign_constant(name, &blk)
+      instance = new_instance(name)
+      assign_attribute(attribute_name(name), instance)
+      @stack.eval(instance, &blk)
+    end
+
+    def assign_constant_to_explicit_attribute(name, const, &blk)
+      instance = new_instance(const)
+      assign_attribute(name, instance)
+      @stack.eval(instance, &blk)
+    end
+
+    def assign_attribute_with_block(name, &blk)
+      struct = OpenStruct.new
+      assign_attribute(name, struct)
+      @stack.eval(struct, &blk)
+    end
+
+    def assign_collection(name, &blk)
+      array = Array.new
+      assign_attribute(name, array)
+      @stack.eval(array, &blk)
+    end
+
+    def assign_attribute(name, value)
+      if @stack.bottom.kind_of?(Array)
+        @stack.bottom << value
+      else
+        define_getter_and_setter_if_needed(name)
+        @stack.bottom.send("#{name}=", value)
+      end
+    end
+
+    def define_getter_and_setter_if_needed(name)
+      return if name.respond_to?("#{name}=")
+
+      @stack.bottom.class.instance_eval do
+        define_method("#{name}=") do |value|
+          instance_variable_set("@#{name}", value)
+        end
+
+        define_method(name) do
+          instance_variable_get("@#{name}")
+        end
+      end
+    end
+
+    def new_instance(const_name)
+      get_or_define_const(const_name).new
+    end
+
+    def get_or_define_const(name_or_const)
+      return name_or_const if name_or_const.is_a?(Class)
+      Object.const_defined?(name_or_const) ? Object.const_get(name_or_const) : Object.const_set(name_or_const, Class.new)
+    end
+  end
+end

data/lib/open_dsl/eval_stack.rb

@@ -0,0 +1,22 @@
+module OpenDsl
+  class EvalStack
+    def initialize(context_binding)
+      @stack = []
+      @context_binding = context_binding
+    end
+
+    def eval_and_keep(object, &blk)
+      @stack.push(object)
+      @context_binding.instance_eval(&blk)
+    end
+
+    def eval(object, &blk)
+      eval_and_keep(object, &blk)
+      @stack.pop
+    end
+
+    def bottom
+      @stack.last
+    end
+  end
+end

data/lib/open_dsl/string_helpers.rb

@@ -0,0 +1,20 @@
+module OpenDsl
+  module StringHelpers
+    def constant_or_constant_name?(str_or_class)
+      return true if str_or_class.is_a?(Class)
+      !!(str_or_class.to_s =~ /^[A-Z]/)
+    end
+
+    def attribute_name(const_name)
+      const_name.to_s.gsub(/::/, '/').
+      gsub(/([A-Z]+)([A-Z][a-z])/,'\1_\2').
+      gsub(/([a-z\d])([A-Z])/,'\1_\2').
+      tr("-", "_").
+      downcase
+    end
+
+    def plural?(str)
+      !!(str.to_s =~ /s$/)
+    end
+  end
+end

data/lib/open_dsl.rb

@@ -0,0 +1,16 @@
+$:.unshift(File.dirname(__FILE__))
+
+require 'ostruct'
+
+require 'open_dsl/string_helpers'
+require 'open_dsl/builder'
+require 'open_dsl/context'
+require 'open_dsl/eval_stack'
+
+module OpenDsl
+  VERSION = '0.1'
+end
+
+def open_dsl(&blk)
+  OpenDsl::Builder.build(&blk)
+end

metadata

@@ -0,0 +1,88 @@
+--- !ruby/object:Gem::Specification 
+name: open_dsl
+version: !ruby/object:Gem::Version 
+  hash: 9
+  prerelease: false
+  segments: 
+  - 0
+  - 1
+  version: "0.1"
+platform: ruby
+authors: 
+- Ian Leitch
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-11-11 00:00:00 +11:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: rspec
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id001
+description: Open DSL is a DSL (Domain Specific Language) builder which aims to provide a highly readable DSL and the flexibility to integrate with existing Classes in your system. Open DSL uses OpenStructs internally when creating collections of attributes.. hence the name :)
+email: 
+- port001@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- lib/open_dsl/builder.rb
+- lib/open_dsl/context.rb
+- lib/open_dsl/eval_stack.rb
+- lib/open_dsl/string_helpers.rb
+- lib/open_dsl.rb
+- LICENSE
+- README.rdoc
+has_rdoc: true
+homepage: http://github.com/ileitch/open_dsl
+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: 23
+      segments: 
+      - 1
+      - 3
+      - 6
+      version: 1.3.6
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.7
+signing_key: 
+specification_version: 3
+summary: A simple DSL library that extends your existing classes.
+test_files: []
+