flex 0.1.1 → 0.2.0

data/VERSION

@@ -1 +1 @@
-0.1.1
+0.2.0

data/lib/flex.rb

@@ -5,8 +5,10 @@ require 'multi_json'
 require 'flex/logger'
 require 'flex/errors'
 require 'flex/utils'
+
 require 'flex/structure/indifferent_access'
 require 'flex/structure/mergeable'
+
 require 'flex/result'
 require 'flex/result/collection'
 require 'flex/result/document'
@@ -14,7 +16,9 @@ require 'flex/result/source_document'
 require 'flex/result/search'
 require 'flex/result/source_search'
 require 'flex/result/bulk'
+
 require 'flex/variables'
+
 require 'flex/template/base'
 require 'flex/template/partial'
 require 'flex/template'
@@ -22,16 +26,23 @@ require 'flex/template/search'
 require 'flex/template/slim_search'
 require 'flex/template/tags'
 require 'flex/template/info'
-require 'flex/class_proxy'
+
+require 'flex/model_manager'
+
+require 'flex/class_proxy/base'
+require 'flex/class_proxy/loader'
+require 'flex/class_proxy/model_sync'
+require 'flex/class_proxy/model'
+require 'flex/class_proxy/related_model'
+
+require 'flex/instance_proxy/base'
+require 'flex/instance_proxy/model'
+require 'flex/instance_proxy/related_model'
+
 require 'flex/loader'
-require 'flex/model/manager'
 require 'flex/related_model'
-require 'flex/related_model/class_sync'
-require 'flex/related_model/class_proxy'
-require 'flex/related_model/instance_proxy'
 require 'flex/model'
-require 'flex/model/class_proxy'
-require 'flex/model/instance_proxy'
+
 require 'flex/http_clients/patron'
 require 'flex/http_clients/rest_client'
 require 'flex/configuration'
@@ -39,7 +50,9 @@ require 'flex/utility_methods'
 
 module Flex
 
-  VERSION = File.read(File.expand_path('../../VERSION', __FILE__)).strip
+  VERSION  = File.read(File.expand_path('../../VERSION', __FILE__)).strip
+  LIB_PATH = __FILE__.sub(/flex.rb$/, '')
+
 
   # The following lines are autogenerated by Flex.info
 

data/lib/flex/class_proxy/base.rb

@@ -0,0 +1,15 @@
+module Flex
+  module ClassProxy
+
+    class Base
+      attr_reader :host_class
+      attr_accessor :variables
+
+      def initialize(host_class)
+        @host_class = host_class
+        @variables  = Variables.new
+      end
+    end
+
+  end
+end

data/lib/flex/class_proxy/loader.rb

@@ -0,0 +1,102 @@
+module Flex
+  module ClassProxy
+    class Loader < Base
+      attr_reader :templates, :partials
+
+      include Template::Info
+
+      def initialize(base)
+        super
+        @sources   = []
+        @templates = {}
+        @partials  = {}
+      end
+
+      # accepts a path to a file or YAML string
+      def load_source_for(klass, source, source_vars)
+        if source.nil? || source != /\n/
+          paths = [ "#{Configuration.flex_dir}/#{source}.yml",
+                    "#{Configuration.flex_dir}/#{ModelManager.class_name_to_type(host_class.name)}.yml",
+                    source ]
+          source = paths.find {|p| File.exist?(p)}
+        end
+        raise ArgumentError, "expected a string (got #{source.inspect})." \
+              unless source.is_a?(String)
+        @sources << [klass, source, source_vars]
+        do_load_source(klass, source, source_vars)
+      end
+
+      # loads a Generic Template source
+      def load_source(source=nil, source_vars=nil)
+        load_source_for(Template, source, source_vars)
+      end
+
+      # loads a Search Template source
+      def load_search_source(source=nil, source_vars=nil)
+        load_source_for(Template::Search, source, source_vars)
+      end
+
+      # loads a SlimSearch Template source
+      def load_slim_search_source(source=nil, source_vars=nil)
+        load_source_for(Template::SlimSearch, source, source_vars)
+      end
+
+      # reloads the sources (useful in the console and used internally)
+      def reload!
+        @sources.each {|k,s,v| do_load_source(k,s,v)}
+      end
+
+      # adds a template instance and defines the template method in the host class
+      def add_template(name, template)
+        templates[name] = template
+        # no define_singleton_method in 1.8.7
+        host_class.instance_eval <<-ruby, __FILE__, __LINE__ + 1
+          def #{name}(vars={})
+            raise ArgumentError, "#{host_class}.#{name} expects a Hash (got \#{vars.inspect})" unless vars.is_a?(Hash)
+            #{host_class.respond_to?(:preprocess_variables) && 'preprocess_variables(vars)'}
+            flex.templates[:#{name}].render(vars)
+          end
+        ruby
+      end
+
+      # http://www.elasticsearch.org/guide/reference/api/multi-search.html
+      # request may be a hash with the templates names as keys and the variable hash as value
+      # or you can also use an array of arrays.
+      # The variables are an hash of variables that will be used to render the msearch template
+      def multi_search(requests, variables={})
+        lines    = requests.map { |name, vars| templates[name].to_msearch(vars) }.join()
+        template = Template.new('GET', '/<<index>>/<<type>>/_msearch')
+        template.send(:do_render, variables.merge(:data => lines)) do |http_response|
+          responses   = []
+          es_response = MultiJson.decode(http_response.body)
+          es_response['responses'].each_with_index do |result, i|
+            responses << Result.new(templates[requests[i].first], requests[i].last, http_response, result)
+          end
+          es_response['responses'] = responses
+          def es_response.responses
+            self['responses']
+          end
+          es_response
+        end
+      end
+
+      private
+
+      def do_load_source(klass, source, source_vars)
+        source = Utils.erb_process(source) unless source.match("\n") # skips non-path
+        hash   = Utils.data_from_source(source)
+        hash.delete('ANCHORS')
+        hash.each do |name, structure|
+          if name.to_s =~ /^_/ # partial
+            partial = Template::Partial.new(structure, self)
+            partials[name.to_sym] = partial
+          else
+            template = klass.new(*structure).setup(self, name, source_vars)
+            add_template(name.to_sym, template)
+          end
+        end
+      end
+
+    end
+  end
+end

data/lib/flex/{model/class_proxy.rb → class_proxy/model.rb}

@@ -1,15 +1,15 @@
 module Flex
-  module Model
-    class ClassProxy < Flex::ClassProxy
+  module ClassProxy
+    class Model < Base
 
-      include RelatedModel::ClassSync
+      include ModelSync
 
       attr_reader :parent_association, :parent_child_map
 
       def initialize(base)
         super
         variables.add :index => Configuration.variables[:index],
-                      :type  => Manager.class_name_to_type(host_class.name)
+                      :type  => ModelManager.class_name_to_type(host_class.name)
       end
 
       def index
@@ -30,7 +30,7 @@ module Flex
 
       def parent(parent_association, map)
         @parent_association = parent_association
-        Manager.parent_types |= map.keys.map(&:to_s)
+        ModelManager.parent_types |= map.keys.map(&:to_s)
         self.type = map.values.map(&:to_s)
         @parent_child_map = map
         @is_child         = true

data/lib/flex/{related_model/class_sync.rb → class_proxy/model_sync.rb}

@@ -1,6 +1,6 @@
 module Flex
-  module RelatedModel
-    module ClassSync
+  module ClassProxy
+    module ModelSync
 
       def self.included(base)
         base.class_eval do
@@ -12,7 +12,7 @@ module Flex
         @synced = synced
         host_class.class_eval do
           raise NotImplementedError, "the class #{self} must implement :after_save and :after_destroy callbacks" \
-                  unless respond_to?(:after_save) && respond_to?(:after_destroy)
+                unless respond_to?(:after_save) && respond_to?(:after_destroy)
           after_save    { flex.sync }
           after_destroy { flex.sync }
         end

data/lib/flex/{related_model/class_proxy.rb → class_proxy/related_model.rb}

@@ -1,6 +1,6 @@
 module Flex
-  module RelatedModel
-    class ClassProxy
+  module ClassProxy
+    class RelatedModel
 
       attr_reader :host_class
 
@@ -8,7 +8,7 @@ module Flex
         @host_class = host_class
       end
 
-      include RelatedModel::ClassSync
+      include ModelSync
 
       alias_method :full_sync, :sync
 

data/lib/flex/{related_model/instance_proxy.rb → instance_proxy/base.rb}

@@ -1,6 +1,7 @@
 module Flex
-  module RelatedModel
-    class InstanceProxy
+  module InstanceProxy
+
+    class Base
       attr_reader :instance, :class_flex
 
       def initialize(instance)

data/lib/flex/{model/instance_proxy.rb → instance_proxy/model.rb}

@@ -1,6 +1,6 @@
 module Flex
-  module Model
-    class InstanceProxy < RelatedModel::InstanceProxy
+  module InstanceProxy
+    class Model < Base
 
       # indexes the document
       # usually called from after_save, you can eventually call it explicitly for example from another callback
@@ -65,21 +65,21 @@ module Flex
       end
 
       def is_parent?
-        @is_parent ||= Manager.parent_types.include?(type)
+        @is_parent ||= ModelManager.parent_types.include?(type)
       end
 
       def metainfo
         @metainfo ||= begin
-                        meta = { :index => index, :type => type, :id => id }
-                        params = {}
-                        params[:routing] = routing if routing
-                        params[:parent]  = parent_instance.id if is_child?
-                        meta.merge!(:params => params) unless params.empty?
-                        meta
-                      end
+          meta = { :index => index, :type => type, :id => id }
+          params = {}
+          params[:routing] = routing if routing
+          params[:parent]  = parent_instance.id if is_child?
+          meta.merge!(:params => params) unless params.empty?
+          meta
+        end
       end
 
-    private
+      private
 
       BASE62_DIGITS = %w(0 1 2 3 4 5 6 7 8 9 A B C D E F G H I J K L M N O P Q R S T U V W X Y Z a b c d e f g h i j k l m n o p q r s t u v w x y z)
 

data/lib/flex/instance_proxy/related_model.rb

@@ -0,0 +1,7 @@
+module Flex
+  module InstanceProxy
+    class RelatedModel < Base
+
+    end
+  end
+end

data/lib/flex/loader.rb

@@ -8,109 +8,11 @@ module Flex
     def self.included(base)
       base.class_eval do
         Flex::Loader.host_classes |= [base]
-        class << self; attr_reader :flex end
-        @flex = Flex::Loader::ClassProxy.new(base)
+        @flex ||= ClassProxy::Loader.new(base)
+        def self.flex; @flex end
       end
     end
 
-    class ClassProxy < Flex::ClassProxy
-      attr_reader :templates, :partials
-
-      include Template::Info
-
-      def initialize(base)
-        super
-        @sources   = []
-        @templates = {}
-        @partials  = {}
-      end
-
-      # accepts a path to a file or YAML string
-      def load_source_for(klass, source, source_vars)
-        if source.nil? || source != /\n/
-          paths = [ "#{Configuration.flex_dir}/#{source}.yml",
-                    "#{Configuration.flex_dir}/#{Model::Manager.class_name_to_type(host_class.name)}.yml",
-                    source ]
-          source = paths.find {|p| File.exist?(p)}
-        end
-        raise ArgumentError, "expected a string (got #{source.inspect})." \
-              unless source.is_a?(String)
-        @sources << [klass, source, source_vars]
-        do_load_source(klass, source, source_vars)
-      end
-
-      # loads a Generic Template source
-      def load_source(source=nil, source_vars=nil)
-        load_source_for(Template, source, source_vars)
-      end
-
-      # loads a Search Template source
-      def load_search_source(source=nil, source_vars=nil)
-        load_source_for(Template::Search, source, source_vars)
-      end
-
-      # loads a SlimSearch Template source
-      def load_slim_search_source(source=nil, source_vars=nil)
-        load_source_for(Template::SlimSearch, source, source_vars)
-      end
-
-      # reloads the sources (useful in the console and used internally)
-      def reload!
-        @sources.each {|k,s,v| do_load_source(k,s,v)}
-      end
-
-      # adds a template instance and defines the template method in the host class
-      def add_template(name, template)
-        templates[name] = template
-        # no define_singleton_method in 1.8.7
-        host_class.instance_eval <<-ruby, __FILE__, __LINE__ + 1
-          def #{name}(vars={})
-            raise ArgumentError, "#{host_class}.#{name} expects a Hash (got \#{vars.inspect})" unless vars.is_a?(Hash)
-            #{host_class.respond_to?(:preprocess_variables) && 'preprocess_variables(vars)'}
-            flex.templates[:#{name}].render(vars)
-          end
-        ruby
-      end
-
-      # http://www.elasticsearch.org/guide/reference/api/multi-search.html
-      # request may be a hash with the templates names as keys and the variable hash as value
-      # or you can also use an array of arrays.
-      # The variables are an hash of variables that will be used to render the msearch template
-      def multi_search(requests, variables={})
-        lines    = requests.map { |name, vars| templates[name].to_msearch(vars) }.join()
-        template = Template.new('GET', '/<<index>>/<<type>>/_msearch')
-        template.send(:do_render, variables.merge(:data => lines)) do |http_response|
-          responses   = []
-          es_response = MultiJson.decode(http_response.body)
-          es_response['responses'].each_with_index do |result, i|
-            responses << Result.new(templates[requests[i].first], requests[i].last, http_response, result)
-          end
-          es_response['responses'] = responses
-          def es_response.responses
-            self['responses']
-          end
-          es_response
-        end
-      end
-
-    private
-
-      def do_load_source(klass, source, source_vars)
-        source = Utils.erb_process(source) unless source.match("\n") # skips non-path
-        hash   = Utils.data_from_source(source)
-        hash.delete('ANCHORS')
-        hash.each do |name, structure|
-          if name.to_s =~ /^_/ # partial
-            partial = Template::Partial.new(structure, self)
-            partials[name.to_sym] = partial
-          else
-            template = klass.new(*structure).setup(self, name, source_vars)
-            add_template(name.to_sym, template)
-          end
-        end
-      end
-
-    end
   end
 end
 

data/lib/flex/model.rb

@@ -3,13 +3,13 @@ module Flex
 
     def self.included(base)
       base.class_eval do
-        class << self; attr_reader :flex end
-        @flex ||= Flex::Model::ClassProxy.new(base)
+        @flex ||= ClassProxy::Model.new(base)
+        def self.flex; @flex end
       end
     end
 
     def flex
-      @flex ||= InstanceProxy.new(self)
+      @flex ||= InstanceProxy::Model.new(self)
     end
 
     def flex_source

data/lib/flex/model_manager.rb

@@ -0,0 +1,65 @@
+module Flex
+  module ModelManager
+
+    extend self
+
+    attr_accessor :parent_types
+    @parent_types = []
+
+    def init
+      Configuration.flex_models.each {|m| eval"::#{m}" if m.is_a?(String) }
+    end
+
+    # arrays of all the types
+    def types
+      type_class_map.keys.map{|k| k.split('/').last}
+    end
+
+    # sets the default parent/child mappings and merges with the config_file
+    # returns the indices structure used for creating the indices
+    def indices(file=Configuration.config_file)
+      @indices ||= begin
+        default = {}.extend Structure::Mergeable
+        Configuration.flex_models.each do |m|
+          m = eval"::#{m}" if m.is_a?(String)
+          next unless m.flex.is_child?
+          index = m.flex.index
+          m.flex.parent_child_map.each do |parent, child|
+            default.add index => {'mappings' => {child => {'_parent' => {'type' => parent }}}}
+          end
+        end
+        hash = YAML.load(Utils.erb_process(file))
+        hash.delete('ANCHORS')
+        default.deep_merge(hash)
+      end
+    end
+
+    # maps all the index/types to the ruby class
+    def type_class_map
+      @type_class_map ||= begin
+        map = {}
+        Configuration.flex_models.each do |m|
+          m = eval("::#{m}") if m.is_a?(String)
+          types = m.flex.type.is_a?(Array) ? m.flex.type : [m.flex.type]
+          types.each do |t|
+            map["#{m.flex.index}/#{t}"] = m
+          end
+        end
+        map
+      end
+    end
+
+    def class_name_to_type(class_name)
+      type = class_name.tr(':', '_')
+      type.gsub!(/([A-Z]+)([A-Z][a-z])/,'\1_\2')
+      type.gsub!(/([a-z\d])([A-Z])/,'\1_\2')
+      type.downcase!
+      type
+    end
+
+    def type_to_class_name(type)
+      type.gsub(/__(.?)/) { "::#{$1.upcase}" }.gsub(/(?:^|_)(.)/) { $1.upcase }
+    end
+
+  end
+end

data/lib/flex/rails.rb

@@ -2,11 +2,11 @@ require 'flex'
 require 'rails'
 require 'flex/rails/helper'
 
-if Rails.version.match /^3/
+if ::Rails.respond_to?(:version) && ::Rails.version.to_i == 3
   require 'flex/rails/engine'
 else
   Flex::Configuration.configure do |c|
-    c.config_file = Rails.root.join('config', 'flex.yml').to_s
-    c.flex_dir    = Rails.root.join('app', 'flex').to_s
+    c.config_file = ::Rails.root.join('config', 'flex.yml').to_s
+    c.flex_dir    = ::Rails.root.join('app', 'flex').to_s
   end
 end

data/lib/flex/rails/helper.rb

@@ -8,7 +8,7 @@ module Flex
         Flex::Configuration.logger = ::Rails.logger
         # we need to reload the flex API methods with the new variables
         Flex.reload!
-        Flex::Model::Manager.init
+        Flex::ModelManager.init
       end
 
     end

data/lib/flex/related_model.rb

@@ -3,13 +3,13 @@ module Flex
 
     def self.included(base)
       base.class_eval do
-        class << self; attr_reader :flex end
-        @flex ||= Flex::RelatedModel::ClassProxy.new(base)
+        @flex ||= ClassProxy::RelatedModel.new(base)
+        def self.flex; @flex end
       end
     end
 
     def flex
-      @flex ||= InstanceProxy.new(self)
+      @flex ||= InstanceProxy::RelatedModel.new(self)
     end
 
   end

data/lib/flex/result/document.rb

@@ -23,7 +23,7 @@ module Flex
       end
 
       def mapped_class(should_raise=false)
-        @mapped_class ||= Model::Manager.type_class_map["#{_index}/#{_type}"]
+        @mapped_class ||= ModelManager.type_class_map["#{_index}/#{_type}"]
       rescue NameError
         raise DocumentMappingError, "the '#{_index}/#{_type}' document cannot be mapped to any class." \
               if should_raise

data/lib/flex/tasks.rb

@@ -110,7 +110,7 @@ module Flex
                                          'Please, use CONFIG_FILE=/path/to/index.yml ' +
                                          'or set the Flex::Configuration.config_file properly' \
                           unless File.exist?(@indices_yaml)
-                    Model::Manager.indices(@indices_yaml)
+                    ModelManager.indices(@indices_yaml)
                   end
     end
 

data/lib/flex/template.rb

@@ -105,7 +105,7 @@ module Flex
 
     def caller_line
       method_name = @host_flex && @name && "#{@host_flex.host_class}.#@name"
-      line = caller.find{|l| l !~ %r|/flex/lib/flex/[^\.]+\.rb|}
+      line = caller.find{|l| l !~ /#{LIB_PATH}/}
       ll = ''
       ll << "#{method_name} from " if method_name
       ll << "#{line}"

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: flex
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.2.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-07-24 00:00:00.000000000 Z
+date: 2012-08-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: multi_json
@@ -125,24 +125,26 @@ files:
 - flex.gemspec
 - lib/flex.rb
 - lib/flex/api_methods.yml
-- lib/flex/class_proxy.rb
+- lib/flex/class_proxy/base.rb
+- lib/flex/class_proxy/loader.rb
+- lib/flex/class_proxy/model.rb
+- lib/flex/class_proxy/model_sync.rb
+- lib/flex/class_proxy/related_model.rb
 - lib/flex/configuration.rb
 - lib/flex/errors.rb
 - lib/flex/http_clients/patron.rb
 - lib/flex/http_clients/rest_client.rb
+- lib/flex/instance_proxy/base.rb
+- lib/flex/instance_proxy/model.rb
+- lib/flex/instance_proxy/related_model.rb
 - lib/flex/loader.rb
 - lib/flex/logger.rb
 - lib/flex/model.rb
-- lib/flex/model/class_proxy.rb
-- lib/flex/model/instance_proxy.rb
-- lib/flex/model/manager.rb
+- lib/flex/model_manager.rb
 - lib/flex/rails.rb
 - lib/flex/rails/engine.rb
 - lib/flex/rails/helper.rb
 - lib/flex/related_model.rb
-- lib/flex/related_model/class_proxy.rb
-- lib/flex/related_model/class_sync.rb
-- lib/flex/related_model/instance_proxy.rb
 - lib/flex/result.rb
 - lib/flex/result/bulk.rb
 - lib/flex/result/collection.rb

data/lib/flex/class_proxy.rb

@@ -1,12 +0,0 @@
-module Flex
-  class ClassProxy
-    attr_reader :host_class
-    attr_accessor :variables
-
-    def initialize(host_class)
-      @host_class = host_class
-      @variables  = Variables.new
-    end
-
-  end
-end

data/lib/flex/model/manager.rb

@@ -1,67 +0,0 @@
-module Flex
-  module Model
-    module Manager
-
-      extend self
-
-      attr_accessor :parent_types
-      @parent_types = []
-
-      def init
-        Configuration.flex_models.each {|m| eval"::#{m}" if m.is_a?(String) }
-      end
-
-      # arrays of all the types
-      def types
-        type_class_map.keys.map{|k| k.split('/').last}
-      end
-
-      # sets the default parent/child mappings and merges with the config_file
-      # returns the indices structure used for creating the indices
-      def indices(file=Configuration.config_file)
-        @indices ||= begin
-          default = {}.extend Structure::Mergeable
-          Configuration.flex_models.each do |m|
-            m = eval"::#{m}" if m.is_a?(String)
-            next unless m.flex.is_child?
-            index = m.flex.index
-            m.flex.parent_child_map.each do |parent, child|
-              default.add index => {'mappings' => {child => {'_parent' => {'type' => parent }}}}
-            end
-          end
-          hash = YAML.load(Utils.erb_process(file))
-          hash.delete('ANCHORS')
-          default.deep_merge(hash)
-        end
-      end
-
-      # maps all the index/types to the ruby class
-      def type_class_map
-        @type_class_map ||= begin
-          map = {}
-          Configuration.flex_models.each do |m|
-            m = eval("::#{m}") if m.is_a?(String)
-            types = m.flex.type.is_a?(Array) ? m.flex.type : [m.flex.type]
-            types.each do |t|
-              map["#{m.flex.index}/#{t}"] = m
-            end
-          end
-          map
-        end
-      end
-
-      def class_name_to_type(class_name)
-        type = class_name.tr(':', '_')
-        type.gsub!(/([A-Z]+)([A-Z][a-z])/,'\1_\2')
-        type.gsub!(/([a-z\d])([A-Z])/,'\1_\2')
-        type.downcase!
-        type
-      end
-
-      def type_to_class_name(type)
-        type.gsub(/__(.?)/) { "::#{$1.upcase}" }.gsub(/(?:^|_)(.)/) { $1.upcase }
-      end
-
-    end
-  end
-end