qor_dsl 0.0.5 → 0.1.0

data/README.md

@@ -1,4 +1,80 @@
-qor_dsl
+Qor Dsl - DSL made easy!
 =======
 
-Qor DSL
+## Description
+
+    Why DSL? Easy to read, Easy to write, Easy to maintain!
+    Why Qor DSL? Make it even easier! Write your DSLs in 10 minutes!
+
+## Usage
+
+1, Adding it as dependency to your Gemspec or Gemfile:
+
+    # your_awesome_gem.gemspec
+    Gem::Specification.new do |gem|
+      gem.add_dependency "qor_dsl"
+    end
+
+    # Gemfile
+    gem "qor_dsl"
+
+2, Defining DSL (Sample configuration support DSLs like [Gemfile](http://gembundler.com))
+
+    # gemfile.rb
+    class Gemfile
+      include Qor::Dsl
+      default_configs [ENV['BUNDLE_GEMFILE'], 'Gemfile']
+
+      node :source
+      node :gem
+
+      node :group do
+        node :gem
+      end
+    end
+
+3, Defining config (Sample Gemfile file used for above config)
+
+    # Gemfile
+    source 'http://rubygems.org'
+
+    gem 'rails', '3.2.8'
+    gem 'unicorn'
+    gem 'devise', :git => "git://github.com/jinzhu/devise.git", :ref => "b94ee9da98b16e4c8fbdc91af8605669d01b17e6"
+
+    group :development do
+      gem 'pry-rails'
+    end
+
+    group :test do
+      gem 'rspec'
+    end
+
+4, Querying config (Please checkout the source code and play with examples under the /example directory for more details)
+
+    # Find by type
+    Gemfile.find(:gem)
+
+    # Find by type and name also chain query
+    Gemfile.find(:group, 'development').find(:gem)
+
+    # Get all gems
+    Gemfile.deep_find(:gem)
+
+    # Find by block
+    Gemfile.deep_find(:gem) do |n|
+      # Find all gems used in development environment
+      parent = n.parent
+      parent.root? || ((parent.config_name == :group) && parent.name == :development)
+    end
+
+    # Qor DSL is designed to be as flexible as possible while helping you to create your DSLs.
+    # Please check source code for all possibilities!
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Added some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/example/Gemfile

@@ -0,0 +1,13 @@
+source 'http://rubygems.org'
+
+gem 'rails', '3.2.8'
+gem 'unicorn'
+gem 'devise', :git => "git://github.com/jinzhu/devise.git", :ref => "b94ee9da98b16e4c8fbdc91af8605669d01b17e6"
+
+group :development do
+  gem 'pry-rails'
+end
+
+group :test do
+  gem 'rspec'
+end

data/example/gemfile.rb

@@ -0,0 +1,50 @@
+#!/usr/bin/env ruby
+
+require 'qor_dsl'
+
+class Gemfile
+  include Qor::Dsl
+  default_configs [ENV['BUNDLE_GEMFILE'], File.join(File.dirname(__FILE__), 'Gemfile')]
+
+  node :source
+  node :gem
+
+  node :group do
+    node :gem
+  end
+
+  node :example do
+    node :gem, :inherit => true
+  end
+end
+
+# Methods for query
+Gemfile.first(:gem)
+Gemfile.first(:gem, 'unicorn')
+
+Gemfile.find(:gem)
+Gemfile.find(:gem, 'rails')
+Gemfile.find(:gem) do |n|
+  !!n.options[:git].nil?
+end
+
+Gemfile.find(:group, 'development').find(:gem)
+
+Gemfile.deep_find(:gem)
+Gemfile.deep_find(:gem) do |n|
+  # Find all gems used in development environment
+  parent = n.parent
+  parent.root? || ((parent.config_name == :group) && parent.name == :development)
+end
+
+# Methods for node
+node = Gemfile.find(:gem, 'devise')
+node.name
+node.value
+node.options
+node.data
+node.config
+node.parent
+node.parents
+node.root
+node.root?

data/lib/qor_dsl/class_method.rb

@@ -19,7 +19,7 @@ module Qor
 
       def default_config
         if @default_configs.is_a?(Array)
-          @default_configs.select {|x| File.exist?(x) }[0]
+          @default_configs.select {|x| File.exist?(x.to_s) }[0]
         else
           @default_configs
         end
@@ -44,6 +44,10 @@ module Qor
         root.find(*arguments, &block)
       end
 
+      def deep_find(*arguments, &block)
+        root.deep_find(*arguments, &block)
+      end
+
       def first(*arguments, &block)
         root.first(*arguments, &block)
       end

data/lib/qor_dsl/config.rb

@@ -32,13 +32,28 @@ module Qor
             node.add_config(config)
             node.data = *data
             node.block = blk
-            node.config.instance_eval(&blk) if block_given? && (config.__children.size > 0)
             __node.add_child(node)
+            node.config.instance_eval(&blk) if block_given? && (config.__children.size > 0)
           end
         DOC
 
         self.instance_eval method_defination
       end
+
+      def to_s
+        result = [
+          ['name',    __name],
+          ['parent',  __parent && __parent.__name],
+          ['__children', __children.keys],
+          ['options', __options],
+          ['block',   __block]
+        ].inject({}) do |s, value|
+          s[value[0]] = value[1] if value[1] && value[1].to_s.length > 0
+          s
+        end.inspect
+
+        "#<Qor::Dsl::Config::0x#{object_id.to_s(16)} #{result}>"
+      end
     end
   end
 end

data/lib/qor_dsl/node.rb

@@ -1,15 +1,31 @@
 module Qor
   module Dsl
     class Node
-      attr_accessor :name, :config, :parent, :children, :data, :options, :block
+      attr_accessor :name, :config, :parent, :children, :data, :options, :block, :all_nodes
 
       def initialize(name=nil, options={})
         self.name   = name
         self.add_config(options[:config] || Qor::Dsl::Config.new('ROOT', self))
       end
 
+      def config_name
+        config.__name
+      end
+
       def inspect_name
-        "{#{config.__name}: #{name || 'nil'}}"
+        "{#{config_name}: #{name || 'nil'}}"
+      end
+
+      def root?
+        root == self
+      end
+
+      def root
+        parent ? parent.root : self
+      end
+
+      def parents
+        parent ? [parent, parent.parents].flatten : []
       end
 
       def options
@@ -39,17 +55,25 @@ module Qor
       end
 
       def config_options_for_child(type)
-        config.__children[type].__options || {}
+        config.__children[type].__options || {} rescue {}
       end
 
       def add_child(child)
         child.parent = self
         children << child
+        root.all_nodes ||= []
+        root.all_nodes << child
+      end
+
+      def deep_find(type=nil, name=nil, &block)
+        nodes = root.all_nodes
+        nodes = nodes.select {|n| n.parents.include?(self) } unless root?
+        find(type, name, nodes, &block)
       end
 
-      def find(type=nil, name=nil, &block)
-        selected_children = children.select do |child|
-          (type.nil? ? true : (child.config.__name.to_s == type.to_s)) &&
+      def find(type=nil, name=nil, nodes=children, &block)
+        selected_children = nodes.select do |child|
+          (type.nil? ? true : (child.config_name.to_s == type.to_s)) &&
             (name.nil? ? true : (child.name.to_s == name.to_s)) &&
             (block.nil? ? true : block.call(child))
         end
@@ -64,11 +88,11 @@ module Qor
         selected_children.is_a?(Array) ? selected_children[0] : selected_children
       end
 
-      def inspect
+      def to_s
         result = [
           ['name',     name],
           ['parent',   parent && parent.inspect_name],
-          ['config',   config.__name],
+          ['config',   config_name],
           ['children', children.map(&:inspect_name)],
           ['data',     data],
           ['block',    block]

data/qor_dsl.gemspec

@@ -2,14 +2,14 @@
 Gem::Specification.new do |gem|
   gem.authors       = ["Jinzhu"]
   gem.email         = ["wosmvp@gmail.com"]
-  gem.description   = %q{Qor DSL}
-  gem.summary       = %q{Qor DSL}
-  gem.homepage      = ""
+  gem.summary       = %q{DSL made easy!}
+  gem.description   = %q{Qor DSL is designed to be as flexible as possible while helping you to create your DSLs.}
+  gem.homepage      = "https://github.com/qor/qor_dsl"
 
   gem.files         = `git ls-files`.split($\)
   gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
   gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
   gem.name          = "qor_dsl"
   gem.require_paths = ["lib"]
-  gem.version       = "0.0.5"
+  gem.version       = "0.1.0"
 end

data/test/layout.rb

@@ -34,6 +34,13 @@ action :google do
   end
 end
 
+action :yahoo do
+  desc "From Yahoo"
+  detect do |app|
+    '...'
+  end
+end
+
 layout :home do
   gadgets []
 end

data/test/layout_test.rb

@@ -10,15 +10,24 @@ describe Layout do
   it "layout config testing" do
     # Find by type
     Layout::Configuration.find(:gadget).length.must_equal 2
+    Layout::Configuration.find(:template).length.must_equal 2
+    Layout::Configuration.deep_find(:template).length.must_equal 3
+    # :settings, :meta, :meta, :meta, :meta, :context, :template
+    Layout::Configuration.find(:gadget, :quick_buy).deep_find().length.must_equal 7
 
     # Find by name
     Layout::Configuration.find(:gadget, 'quick_buy').name.must_equal :quick_buy
+    Layout::Configuration.deep_find(:desc, "From Google").value.must_equal "From Google"
 
     # Find by block
     Layout::Configuration.first(:template) do |n|
       n.options[:since] > "12:50"
     end.value.must_equal 'Hello World2'
 
+    Layout::Configuration.deep_find(:desc) do |n|
+      n.parents.include?(Layout::Configuration.find(:action, :google))
+    end[0].value.must_equal 'From Google'
+
     # Inherit
     Layout::Configuration.find(:gadget, :product_link).find(:template)[0].value.must_equal "Hello World"
 
@@ -28,6 +37,9 @@ describe Layout do
     # Options
     Layout::Configuration.find(:template)[1].options.must_equal({:since => "13:00", :to => "18:00"})
 
+    # Parents
+    Layout::Configuration.find(:gadget, :quick_buy).first(:template).parents.count.must_equal 2
+
     # More is coming... (multi, alias_node)
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: qor_dsl
 version: !ruby/object:Gem::Version
-  version: 0.0.5
+  version: 0.1.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,9 +9,10 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-10-19 00:00:00.000000000 Z
+date: 2012-10-20 00:00:00.000000000 Z
 dependencies: []
-description: Qor DSL
+description: Qor DSL is designed to be as flexible as possible while helping you to
+  create your DSLs.
 email:
 - wosmvp@gmail.com
 executables: []
@@ -23,6 +24,8 @@ files:
 - Gemfile.lock
 - README.md
 - Rakefile
+- example/Gemfile
+- example/gemfile.rb
 - lib/qor_dsl.rb
 - lib/qor_dsl/class_method.rb
 - lib/qor_dsl/config.rb
@@ -31,7 +34,7 @@ files:
 - test/configure.rb
 - test/layout.rb
 - test/layout_test.rb
-homepage: ''
+homepage: https://github.com/qor/qor_dsl
 licenses: []
 post_install_message: 
 rdoc_options: []
@@ -54,7 +57,7 @@ rubyforge_project:
 rubygems_version: 1.8.24
 signing_key: 
 specification_version: 3
-summary: Qor DSL
+summary: DSL made easy!
 test_files:
 - test/configure.rb
 - test/layout.rb