gummi 0.1.2 → 0.2.0

data/.gitignore

@@ -16,3 +16,4 @@ spec/reports
 test/tmp
 test/version_tmp
 tmp
+tags

data/gummi.gemspec

@@ -17,12 +17,13 @@ Gem::Specification.new do |spec|
   spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
   spec.require_paths = ["lib"]
 
-  spec.add_dependency('virtus', '~> 1.0.0')
-  spec.add_dependency('elasticsearch', '~> 0.4.0')
-  spec.add_dependency('activesupport', '>= 3.0')
-  spec.add_dependency('activemodel', '>= 3.0')
-  spec.add_dependency('hooks', '~>0.3.3')
-  spec.add_dependency('leaflet')
+  spec.add_dependency 'virtus', '~> 1.0.0'
+  spec.add_dependency 'elasticsearch', '~> 0.4.0'
+  spec.add_dependency 'activesupport', '>= 3.0'
+  spec.add_dependency 'activemodel', '>= 3.0'
+  spec.add_dependency 'hooks', '~>0.3.3'
+  spec.add_dependency 'leaflet'
+  spec.add_dependency 'hashie', '>= 2.0.0'
 
   spec.add_development_dependency('bundler', '~> 1.3')
   spec.add_development_dependency('pry')

data/lib/gummi.rb

@@ -4,40 +4,46 @@ require 'active_support/core_ext'
 require 'active_model'
 require 'hooks'
 require 'leaflet'
+require 'hashie/mash'
 
-require "repobahn/repository"
-require "repobahn/entity"
+require 'repobahn/repository/active_record'
+require 'repobahn/repository'
+require 'repobahn/entity'
 
-require "gummi/version"
-require "gummi/api"
-require "gummi/document/attributes"
-require "gummi/document"
-require "gummi/entity"
-require "gummi/index"
-require "gummi/document/object"
-require "gummi/repository"
-require "gummi/repository/result"
-require "gummi/fields/boolean"
-require "gummi/fields/time"
-require "gummi/fields/integer"
-require "gummi/fields/positive_integer"
-require "gummi/fields/keyword"
-require "gummi/fields/ngram_and_plain"
-require "gummi/fields/path_hierarchy"
-require "gummi/fields/string"
-require "gummi/fields/sanitized_string"
-require "gummi/default_index"
-require "gummi/document/search/searching"
-require "gummi/document/search/filtered"
-require "gummi/document/search/raw"
-require "gummi/document/search/result"
+require 'gummi/version'
+require 'gummi/errors'
+require 'gummi/api'
+
+require 'gummi/db_layer/index'
+require 'gummi/db_layer/document/attributes'
+require 'gummi/db_layer/document/object'
+require 'gummi/db_layer/document'
+require 'gummi/db_layer/fields/boolean'
+require 'gummi/db_layer/fields/time'
+require 'gummi/db_layer/fields/integer'
+require 'gummi/db_layer/fields/positive_integer'
+require 'gummi/db_layer/fields/keyword'
+require 'gummi/db_layer/fields/ngram_and_plain'
+require 'gummi/db_layer/fields/path_hierarchy'
+require 'gummi/db_layer/fields/string'
+require 'gummi/db_layer/fields/sanitized_string'
+require 'gummi/db_layer/default_index'
+require 'gummi/db_layer/document/search/searching'
+require 'gummi/db_layer/document/search/filtered'
+require 'gummi/db_layer/document/search/raw'
+require 'gummi/db_layer/document/search/result'
+
+require 'gummi/repository_layer/repository'
+require 'gummi/repository_layer/repository/result'
+
+require 'gummi/entity_layer/entity'
 
 module Gummi
   def self.env
     if defined? Rails
       Rails.env
     else
-      RAILS_ENV || "development"
+      RAILS_ENV || 'development'
     end
   end
 end

data/lib/gummi/api.rb

@@ -1,7 +1,9 @@
 module Gummi
   module API
+
     def self.client
       @client ||= ::Elasticsearch::Client.new log: false
     end
+
   end
-end
+end

data/lib/gummi/db_layer/default_index.rb

@@ -0,0 +1,15 @@
+module Gummi
+  module DbLayer
+    class DefaultIndex
+      include Gummi::DbLayer::Index
+
+      def self.name
+        if defined? Rails
+          "#{Rails.application.class.name.deconstantize.underscore}_#{Rails.env}"
+        else
+          "gummi_#{Gummi.env}"
+        end
+      end
+    end
+  end
+end

data/lib/gummi/db_layer/document.rb

@@ -0,0 +1,206 @@
+module Gummi
+  module DbLayer
+    module Document
+      extend ActiveSupport::Concern
+
+      included do
+        include Virtus.model
+        include Gummi::DbLayer::Document::Attributes
+      end
+
+      # –––––––––––––
+      # Class Methods
+      # –––––––––––––
+
+      module ClassMethods
+
+        # ––––––––––––––––––––––
+        # Public Persistence API
+        # ––––––––––––––––––––––
+
+        def create(*args)
+          instance = new(*args)
+          instance.create ? instance : nil
+        end
+
+        def get(*args)
+          get! *args
+        rescue ::Elasticsearch::Transport::Transport::Errors::NotFound
+          nil
+        end
+
+        # –––––––––––––––––––––
+        # Public Conversion API
+        # –––––––––––––––––––––
+
+        def hits_to_documents(hits)
+          documents = [hits].flatten.map { |hit| hit_to_document(hit) }
+          documents.length > 1 ? documents : documents.first
+        end
+
+        def hit_to_document(hit)
+          attributes = { id: hit._id, version: hit._version }
+          attributes.merge!(parent_id_attribute_name => hit.fields._parent) if hit.fields && hit.fields._parent
+          attributes.merge! hit._source if hit._source
+          self.new attributes
+        end
+
+        # ––––––––––––––––––––––––––––––
+        # Index and Document definitions
+        # ––––––––––––––––––––––––––––––
+
+        def index(*args)
+          @index = args.first unless args.empty?
+          @index || Gummi::DbLayer::DefaultIndex
+        end
+
+        def document_type(*args)
+          @document_type = args.first.to_sym unless args.empty?
+          @document_type || name.demodulize.underscore.to_sym
+        end
+
+        def parent(model)
+          parent_document_type model.document_type
+        end
+
+        def parent_document_type(*args)
+          @parent_document_type = args.first unless args.empty?
+          parent_id_attribute_name "#{@parent_document_type}_id".to_sym if @parent_document_type && !parent_id_attribute_name
+          @parent_document_type
+        end
+
+        def parent_id_attribute_name(*args)
+          unless args.empty?
+            @parent_id_attribute_name = args.first
+            attr_accessor @parent_id_attribute_name
+          end
+          @parent_id_attribute_name
+        end
+
+        # ––––––––––––––––
+        # Public Index API
+        # ––––––––––––––––
+
+        def sync_mapping!
+          client.indices.put_mapping creation_options
+        end
+
+        def creation_options
+          result = {
+            index: index.name,
+            type:  document_type,
+            body: {
+              document_type => {
+                properties: mapping,
+              }
+            }
+          }
+          result[:body][document_type].merge!(_parent: { type: parent_document_type }) if parent_document_type.present?
+          result
+        end
+
+        # –––––––––––––––––
+        # Public Search API
+        # –––––––––––––––––
+
+        def new_filtered_search(options = {})
+          Gummi::DbLayer::Document::Search::Filtered.new default_search_options.merge(options)
+        end
+
+        def new_raw_search(options = {})
+          Gummi::DbLayer::Document::Search::Raw.new default_search_options.merge(options)
+        end
+
+        def default_search_options
+          {
+            document_class: self,
+            index:          index.name,
+            type:           document_type,
+          }
+        end
+
+        # –––––––––––––––––––––––––––
+        # Internal Backend Connection
+        # –––––––––––––––––––––––––––
+
+        def client
+          Gummi::API.client
+        end
+
+        private
+
+        # ––––––––––––––––––––––––
+        # Internal Persistence API
+        # ––––––––––––––––––––––––
+
+        def get!(id, parent_id = nil)
+          options = { index: index.name, type: document_type, id: id, fields: %w{ _source _parent } }
+          if parent_id
+            options.merge! parent: parent_id
+          elsif parent_document_type
+            raise ArgumentError, "The parent_id attribute is required for getting #{name} from Elastic Search"
+          end
+          response = Hashie::Mash.new client.get options
+          hit_to_document response
+        end
+
+      end
+
+      # ––––––––––––––––
+      # Instance Methods
+      # ––––––––––––––––
+
+      attr_accessor :id
+      attr_accessor :version
+
+      # ––––––––––––––––––––––
+      # Public Persistence API
+      # ––––––––––––––––––––––
+
+      def create(method = :create)
+        attributes = self.attributes
+        if parent_id_attribute_name && parent_id = self.send(parent_id_attribute_name)
+          options = { parent: parent_id }
+        else
+          options = {}
+        end
+        raise ArgumentError unless [:create, :index].include?(method)
+        response = Hashie::Mash.new client.send(method, options.merge(index: index.name, type: document_type, id: self.id, body: attributes))
+        if response.ok
+          self.id      = response._id
+          self.version = response._version
+          true
+        else
+          false
+        end
+      end
+
+      def overwrite
+        create :index
+      end
+
+      private
+
+      # ––––––––––––––––––––
+      # Class method proxies
+      # ––––––––––––––––––––
+
+      def index
+        self.class.index
+      end
+
+      def document_type
+        self.class.document_type
+      end
+
+      def parent_id_attribute_name
+        self.class.parent_id_attribute_name
+      end
+
+      def client
+        self.class.client
+      end
+
+    end
+  end
+end

data/lib/gummi/db_layer/document/attributes.rb

@@ -0,0 +1,40 @@
+module Gummi
+  module DbLayer
+    module Document
+      module Attributes
+        extend ActiveSupport::Concern
+
+        module ClassMethods
+
+          def mapping_for_attribute(attribute)
+            if attribute.is_a? Virtus::Attribute::EmbeddedValue
+              { properties: attribute.primitive.mapping }
+            elsif attribute.is_a? Virtus::Attribute::Collection
+              mapping_for_attribute(attribute.member_type)
+            else
+              begin
+                attribute.mapping
+              rescue NoMethodError => exception
+                if exception.message.include?("`mapping'")
+                  raise Errors::ImplicitMappingForbidden, "Sorry, you have to explicitly define the attribute type for #{attribute.instance_variable_name rescue nil} in #{self} or maybe you tried to use Array[] where it is not allowed. Original Exception: #{exception.message}"
+                else
+                  raise exception
+                end
+              end
+            end
+          end
+
+          def mapping
+            result = {}
+            attribute_set.each do |attribute|
+              result.merge! attribute.name => mapping_for_attribute(attribute)
+            end
+            result
+          end
+
+        end
+
+      end
+    end
+  end
+end

data/lib/gummi/db_layer/document/object.rb

@@ -0,0 +1,15 @@
+module Gummi
+  module DbLayer
+    module Document
+      module Object
+        extend ActiveSupport::Concern
+
+        included do
+          include Virtus.model
+          include Gummi::DbLayer::Document::Attributes
+        end
+
+      end
+    end
+  end
+end

data/lib/gummi/db_layer/document/search/filtered.rb

@@ -0,0 +1,42 @@
+module Gummi
+  module DbLayer
+    module Document
+      module Search
+        class Filtered
+          include Gummi::DbLayer::Document::Search::Searching
+
+          attribute :query_string,  Gummi::DbLayer::Fields::SanitizedString
+          attribute :query_filters, Array[Hash],                    default: []
+          attribute :facets,        Hash,                           default: {}
+
+          def to_client_args
+            args = super
+            args[:body] = { query: filtered, facets: facets }
+            args
+          end
+
+          def query
+            if query_string.present?
+              {query_string: { query: query_string}}
+            else
+              {match_all: {}}
+            end
+          end
+
+          def filtered
+            { 'filtered' => { 'query' => query, 'filter' => process_query_filters }}
+          end
+
+          def process_query_filters
+            if query_filters.length > 1
+              {and: query_filters}
+            else
+              query_filters.first
+            end
+          end
+
+        end
+      end
+    end
+  end
+end

data/lib/gummi/db_layer/document/search/raw.rb

@@ -0,0 +1,12 @@
+module Gummi
+  module DbLayer
+    module Document
+      module Search
+        class Raw
+          include Gummi::DbLayer::Document::Search::Searching
+
+        end
+      end
+    end
+  end
+end