symbol_decoration 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 50f521f730b37b3aa512481b9a3cd4ac0df32bdd
+  data.tar.gz: ace420edc4102c58d385212e33a83ce639aca91b
+SHA512:
+  metadata.gz: 447af63c714e8d6d572a9ae75575c1a5d2009515911b4e32bb5fdff36627961c1b62396f72cf8eaf380785712fe27e142ad68bf7fcc9a196409c1329ddee4358
+  data.tar.gz: f03dd020f3df2dc87547ff4e3aa4ba4df29a75ec8c513bdaf814456e3a03bef3c9bfb92950af387ee3fad166db88cf94febd88037a9e2ec448bf71a4701f47c3

data/README.md

@@ -0,0 +1,50 @@
+Symbol Decoration
+=================
+
+The Symbol Decoration gem provides symbol method extensions to implement
+DSL such as like `where(:field.in => [1,2,3])`.
+
+The goal is to allow different ORMs such as Mongoid and NoBrainer to co-exist as
+both ORMs need such functionality.
+
+Usage
+=====
+
+In the following example: `where(:field.in => [1,2,3])`, the `in` keyword is a *decorator*, and *decorates* the `:field` symbol.
+
+To register decorators, you may call `Symbol::Decoration.register(decorator, ...)`.  For example:
+
+```ruby
+Symbol::Decoration.register(:in)
+Symbol::Decoration.register(*%w(in nin eq ne not gt ge gte lt le lte))
+```
+
+Once registered, a decorator can be used with `symbol.decorator`, which returns
+a `Symbol::Decoration` instance.
+
+To support the lowest common denominator, decorators may accept arguments and
+blocks. For example, `:field.gt(5)` is valid.
+
+You may retrieve the decoration properties with:
+
+* `decorated_symbol.symbol` to get the symbol which is being decorated.
+* `decorated_symbol.decorator` to get the decoration (for example `:gt`).
+* `decorated_symbol.args` to get the decoration arguments.
+* `decorated_symbol.blocks` to get the decoration block.
+
+Full example:
+
+```ruby
+Symbol::Decoration.register(:gt)
+
+:field.gt.class            == Symbol::Decoration
+:field.gt.symbol           == :field
+:field.gt.decorator        == :gt
+:field.gt(5).args          == [5]
+:field.gt { 5 }.block.call == 5
+```
+
+License
+=======
+
+Symbol Decoration is MIT Licensed.

data/lib/symbol_decoration.rb

@@ -0,0 +1,13 @@
+class Symbol
+  Decoration = Struct.new(:symbol, :decorator, :args, :block) do
+    def self.register(*decorators)
+      Symbol.class_eval do
+        decorators.map(&:to_sym).each do |decorator|
+          define_method(decorator) do |*args, &block|
+            Decoration.new(self, decorator, args, block)
+          end
+        end
+      end
+    end
+  end
+end

metadata

@@ -0,0 +1,47 @@
+--- !ruby/object:Gem::Specification
+name: symbol_decoration
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Nicolas Viennot
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-11-14 00:00:00.000000000 Z
+dependencies: []
+description: Support for symbol decorations such as where(:field.in => [1,2,3])
+email:
+- nicolas@viennot.biz
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- README.md
+- lib/symbol_decoration.rb
+homepage: http://github.com/nviennot/symbol_decoration
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.2.2
+signing_key: 
+specification_version: 4
+summary: Symbol Decoration
+test_files: []
+has_rdoc: false