origin 0.0.0.alpha → 1.0.0.alpha

data/lib/origin/selector.rb

@@ -1,5 +1,144 @@
 # encoding: utf-8
 module Origin
-  class Selector < Hash
+
+  # The selector is a special kind of hash that knows how to serialize values
+  # coming into it as well as being alias and locale aware for key names.
+  class Selector < Smash
+
+    def merge!(other)
+      other.each_pair do |key, value|
+        store(key, value)
+      end
+    end
+
+    # Store the value in the selector for the provided key. The selector will
+    # handle all necessary serialization and localization in this step.
+    #
+    # @example Store a value in the selector.
+    #   selector.store(:key, "testing")
+    #
+    # @param [ String, Symbol ] key The name of the attribute.
+    # @param [ Object ] value The value to add.
+    #
+    # @return [ Object ] The stored object.
+    #
+    # @since 1.0.0
+    def store(key, value)
+      name, serializer = storage_pair(key)
+      if multi_selection?(name)
+        super(name, evolve_multi(value))
+      else
+        super(normalized_key(name, serializer), evolve(serializer, value))
+      end
+    end
+    alias :[]= :store
+
+    private
+
+    # Evolves a multi-list selection, like an $and or $or criterion, and
+    # performs the necessary serialization.
+    #
+    # @api private
+    #
+    # @example Evolve the multi-selection.
+    #   selector.evolve_multi([{ field: "value" }])
+    #
+    # @param [ Array<Hash> ] The multi-selection.
+    #
+    # @return [ Array<Hash> ] The serialized values.
+    #
+    # @since 1.0.0
+    def evolve_multi(value)
+      value.map do |val|
+        Hash[val.map do |key, _value|
+          name = key.to_s
+          serializer = serializers[name]
+          [ normalized_key(name, serializer), evolve(serializer, _value) ]
+        end]
+      end
+    end
+
+    # Evolve a single key selection with various types of values.
+    #
+    # @api private
+    #
+    # @example Evolve a simple selection.
+    #   selector.evolve(field, 5)
+    #
+    # @param [ Object ] serializer The optional serializer for the field.
+    # @param [ Object ] value The value to serialize.
+    #
+    # @return [ Object ] The serialized object.
+    #
+    # @since 1.0.0
+    def evolve(serializer, value)
+      case value
+      when Hash
+        evolve_hash(serializer, value)
+      when Array
+        evolve_array(serializer, value)
+      else
+        (serializer || value.class).evolve(value)
+      end
+    end
+
+    # Evolve a single key selection with array values.
+    #
+    # @api private
+    #
+    # @example Evolve a simple selection.
+    #   selector.evolve(field, [ 1, 2, 3 ])
+    #
+    # @param [ Object ] serializer The optional serializer for the field.
+    # @param [ Array<Object> ] value The array to serialize.
+    #
+    # @return [ Object ] The serialized array.
+    #
+    # @since 1.0.0
+    def evolve_array(serializer, value)
+      value.map! do |_value|
+        evolve(serializer, _value)
+      end
+    end
+
+    # Evolve a single key selection with hash values.
+    #
+    # @api private
+    #
+    # @example Evolve a simple selection.
+    #   selector.evolve(field, { "$gt" => 5 })
+    #
+    # @param [ Object ] serializer The optional serializer for the field.
+    # @param [ Hash ] value The hash to serialize.
+    #
+    # @return [ Object ] The serialized hash.
+    #
+    # @since 1.0.0
+    def evolve_hash(serializer, value)
+      value.each_pair do |operator, _value|
+        if operator =~ /exists|type|size/
+          value[operator] = _value
+        else
+          value[operator] = evolve(serializer, _value)
+        end
+      end
+    end
+
+    # Determines if the selection is a multi-select, like an $and or $or
+    # selection.
+    #
+    # @api private
+    #
+    # @example Is the selection a multi-select?
+    #   selector.multi_selection?("$and")
+    #
+    # @param [ String ] key The key to check.
+    #
+    # @return [ true, false ] If the key is for a multi-select.
+    #
+    # @since 1.0.0
+    def multi_selection?(key)
+      key =~ /\$and|\$or/
+    end
   end
 end

data/lib/origin/smash.rb

@@ -0,0 +1,85 @@
+# encoding: utf-8
+module Origin
+
+  # This is a smart hash for use with options and selectors.
+  class Smash < Hash
+
+    # @attribute [r] aliases The aliases.
+    # @attribute [r] serializers The serializers.
+    attr_reader :aliases, :serializers
+
+    # Perform a deep copy of the smash.
+    #
+    # @example Perform a deep copy.
+    #   smash.__deep_copy__
+    #
+    # @return [ Smash ] The copied hash.
+    #
+    # @since 1.0.0
+    def __deep_copy__
+      self.class.new(aliases, serializers) do |copy|
+        each_pair do |key, value|
+          copy.store(key, value.__deep_copy__)
+        end
+      end
+    end
+
+    # Initialize the new selector.
+    #
+    # @example Initialize the new selector.
+    #   Origin::Smash.new(aliases, serializers)
+    #
+    # @param [ Hash ] aliases A hash of mappings from aliases to the actual
+    #   field names in the database.
+    # @param [ Hash ] serializers An optional hash of objects that are
+    #   responsible for serializing values. The keys of the hash must be
+    #   strings that match the field name, and the values must respond to
+    #   #localized? and #evolve(object).
+    #
+    # @since 1.0.0
+    def initialize(aliases = {}, serializers = {})
+      @aliases, @serializers = aliases, serializers
+      yield(self) if block_given?
+    end
+
+    private
+
+    # Get the normalized value for the key. If localization is in play the
+    # current locale will be appended to the key in MongoDB dot notation.
+    #
+    # @api private
+    #
+    # @example Get the normalized key name.
+    #   smash.normalized_key("field", serializer)
+    #
+    # @param [ String ] name The name of the field.
+    # @param [ Object ] serializer The optional field serializer.
+    #
+    # @return [ String ] The normalized key.
+    #
+    # @since 1.0.0
+    def normalized_key(name, serializer)
+      serializer && serializer.localized? ? "#{name}.#{::I18n.locale}" : name
+    end
+
+    # Get the pair of objects needed to store the value in a hash by the
+    # provided key. This is the database field name and the serializer.
+    #
+    # @api private
+    #
+    # @example Get the name and serializer.
+    #   smash.storage_pair("id")
+    #
+    # @param [ Symbol, String ] key The key provided to the selection.
+    #
+    # @return [ Array<String, Object> ] The name of the db field and
+    #   serializer.
+    #
+    # @since 1.0.0
+    def storage_pair(key)
+      field = key.to_s
+      name = aliases[field] || field
+      [ name, serializers[name] ]
+    end
+  end
+end

data/lib/origin/version.rb

@@ -1,4 +1,4 @@
 # encoding: utf-8
 module Origin
-  VERSION = "0.0.0.alpha"
+  VERSION = "1.0.0.alpha"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: origin
 version: !ruby/object:Gem::Version
-  version: 0.0.0.alpha
+  version: 1.0.0.alpha
   prerelease: 6
 platform: ruby
 authors:
@@ -9,30 +9,88 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2011-12-18 00:00:00.000000000 Z
+date: 2012-04-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: rspec
-  requirement: &70272334463460 !ruby/object:Gem::Requirement
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: '2.6'
+        version: '3.1'
   type: :development
   prerelease: false
-  version_requirements: *70272334463460
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.1'
 - !ruby/object:Gem::Dependency
-  name: watchr
-  requirement: &70272334462920 !ruby/object:Gem::Requirement
+  name: guard-rspec
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.6'
+- !ruby/object:Gem::Dependency
+  name: i18n
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
         version: '0.6'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.8'
   type: :development
   prerelease: false
-  version_requirements: *70272334462920
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.8'
+- !ruby/object:Gem::Dependency
+  name: tzinfo
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.3.22
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.3.22
 description: Origin is a simple DSL for generating MongoDB selectors and options
 email:
 - durran@gmail.com
@@ -40,62 +98,33 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- lib/origin/ext/array.rb
-- lib/origin/ext/hash.rb
-- lib/origin/ext/nil.rb
-- lib/origin/ext/object.rb
-- lib/origin/ext.rb
-- lib/origin/optional/batch_size.rb
-- lib/origin/optional/hint.rb
-- lib/origin/optional/limit.rb
-- lib/origin/optional/max_scan.rb
-- lib/origin/optional/no_timeout.rb
-- lib/origin/optional/only.rb
-- lib/origin/optional/read.rb
-- lib/origin/optional/return_key.rb
-- lib/origin/optional/show_disk_loc.rb
-- lib/origin/optional/skip.rb
-- lib/origin/optional/slice.rb
-- lib/origin/optional/snapshot.rb
-- lib/origin/optional/transformer.rb
-- lib/origin/optional/without.rb
+- lib/origin/extensions/array.rb
+- lib/origin/extensions/big_decimal.rb
+- lib/origin/extensions/boolean.rb
+- lib/origin/extensions/date.rb
+- lib/origin/extensions/date_time.rb
+- lib/origin/extensions/hash.rb
+- lib/origin/extensions/nil_class.rb
+- lib/origin/extensions/numeric.rb
+- lib/origin/extensions/object.rb
+- lib/origin/extensions/range.rb
+- lib/origin/extensions/regexp.rb
+- lib/origin/extensions/set.rb
+- lib/origin/extensions/string.rb
+- lib/origin/extensions/symbol.rb
+- lib/origin/extensions/time.rb
+- lib/origin/extensions/time_with_zone.rb
+- lib/origin/extensions.rb
+- lib/origin/forwardable.rb
+- lib/origin/key.rb
+- lib/origin/macroable.rb
+- lib/origin/mergeable.rb
 - lib/origin/optional.rb
 - lib/origin/options.rb
 - lib/origin/queryable.rb
-- lib/origin/selection/all.rb
-- lib/origin/selection/and.rb
-- lib/origin/selection/between.rb
-- lib/origin/selection/elem_match.rb
-- lib/origin/selection/exists.rb
-- lib/origin/selection/gt.rb
-- lib/origin/selection/gte.rb
-- lib/origin/selection/in.rb
-- lib/origin/selection/key.rb
-- lib/origin/selection/lt.rb
-- lib/origin/selection/lte.rb
-- lib/origin/selection/max_distance.rb
-- lib/origin/selection/mod.rb
-- lib/origin/selection/ne.rb
-- lib/origin/selection/near.rb
-- lib/origin/selection/near_sphere.rb
-- lib/origin/selection/nin.rb
-- lib/origin/selection/nor.rb
-- lib/origin/selection/or.rb
-- lib/origin/selection/size.rb
-- lib/origin/selection/strategies/add.rb
-- lib/origin/selection/strategies/expanded.rb
-- lib/origin/selection/strategies/intersect.rb
-- lib/origin/selection/strategies/multi.rb
-- lib/origin/selection/strategies/override.rb
-- lib/origin/selection/strategies/union.rb
-- lib/origin/selection/strategies.rb
-- lib/origin/selection/type.rb
-- lib/origin/selection/where.rb
-- lib/origin/selection/within_box.rb
-- lib/origin/selection/within_circle.rb
-- lib/origin/selection/within_spherical_circle.rb
-- lib/origin/selection.rb
+- lib/origin/selectable.rb
 - lib/origin/selector.rb
+- lib/origin/smash.rb
 - lib/origin/version.rb
 - lib/origin.rb
 - Rakefile
@@ -111,6 +140,9 @@ required_ruby_version: !ruby/object:Gem::Requirement
   - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
+      segments:
+      - 0
+      hash: 2248080599464192453
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
@@ -119,7 +151,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: 1.3.6
 requirements: []
 rubyforge_project: origin
-rubygems_version: 1.8.10
+rubygems_version: 1.8.19
 signing_key: 
 specification_version: 3
 summary: Simple DSL for MongoDB query generation

data/lib/origin/ext.rb

@@ -1,5 +0,0 @@
-# encoding: utf-8
-require "origin/ext/array"
-require "origin/ext/hash"
-require "origin/ext/nil"
-require "origin/ext/object"