lycra 0.0.7 → 5.0.0

data/lib/lycra/version.rb

@@ -1,8 +1,8 @@
 module Lycra
   module Version
-    MAJOR = '0'
+    MAJOR = '5'
     MINOR = '0'
-    PATCH = '7'
+    PATCH = '0'
     VERSION = "#{MAJOR}.#{MINOR}.#{PATCH}"
 
     class << self

data/spec/spec_helper.rb

@@ -1,20 +1,25 @@
+require 'byebug'
 require 'faker'
-require 'factory_girl'
+require 'factory_bot'
+require 'active_record'
+require 'yaml'
 require 'lycra'
 require 'rspec'
 require 'coveralls'
 Coveralls.wear!
 
-#Dir[File.join(File.dirname(__FILE__), '..', "spec/support/**/*.rb")].each { |f| require f }
-Dir[File.join(File.dirname(__FILE__), '..', "spec/factories/**/*.rb")].each { |f| require f }
+ActiveRecord::Base.establish_connection(
+  YAML::load(File.open('config/database.yml'))['test']
+)
 
-#LYCRA_ES1_CLIENT = Elasticsearch::Client.new host: 'localhost', port: 9201
-LYCRA_ES2_CLIENT = Elasticsearch::Client.new host: 'localhost', port: 4500
-Elasticsearch::Model.client = LYCRA_ES2_CLIENT
+Dir[File.join(File.dirname(__FILE__), '..', "app/models/**/*.rb")].each { |f| require f }
+Dir[File.join(File.dirname(__FILE__), '..', "app/documents/**/*.rb")].each { |f| require f }
+Dir[File.join(File.dirname(__FILE__), '..', "spec/support/**/*.rb")].each { |f| require f }
+Dir[File.join(File.dirname(__FILE__), '..', "spec/factories/**/*.rb")].each { |f| require f }
 
 RSpec.configure do |config|
-  # configure factory_girl syntax methods
-  config.include FactoryGirl::Syntax::Methods
+  # configure factory_bot syntax methods
+  config.include FactoryBot::Syntax::Methods
 
   # rspec-expectations config goes here. You can use an alternate
   # assertion/expectation library such as wrong or the stdlib/minitest

data/spec/support/foo.rb

@@ -0,0 +1,120 @@
+#
+# a document defining mappings, using the Lycra::Document mixin
+#
+
+  class FooSubject
+    def foo
+      'foo'
+    end
+
+    def bar
+      "BAR"
+    end
+  end
+
+  class Foo
+    include Lycra::Document
+
+    def initialize(*args, **opts, &block)
+      @subject = args.first
+    end
+
+    document_type 'Thingamajig'
+
+    attribute :foo, String
+
+    attribute :bar, Integer do
+      resolve ->(obj, arg, ctx) do
+        return 35
+      end
+    end
+
+    attribute :baz do
+      type String
+      resolve do |obj, arg, ctx|
+        "baz"
+      end
+    end
+
+    attribute :blah, Integer, ->(obj, arg, ctx) { 35 }
+    attribute :yadda, String, :bar
+
+    attribute :bad do
+      type String
+      resolve ->(obj, arg, ctx) do
+        return '35'
+      end
+    end
+  end
+
+#
+# a document defining mappings, inheriting from Lycra::Document::Base
+#
+
+  class BarSubject
+    def foo
+      'bar'
+    end
+
+    def bar
+      "FOO"
+    end
+  end
+
+  class Bar < Lycra::Document::Base
+    attribute :foo, String
+
+    attribute :bar, Integer do
+      resolve ->(obj, arg, ctx) do
+        return 35
+      end
+    end
+
+    attribute :baz do
+      type String
+      resolve do |obj, arg, ctx|
+        "baz"
+      end
+    end
+
+    attribute :blah, Integer, ->(obj, arg, ctx) { 35 }
+    attribute :yadda, String do
+      resolve :bar
+    end
+
+    attribute :bad do
+      type String
+      resolve ->(obj, arg, ctx) do
+        return '35'
+      end
+    end
+  end
+
+=begin
+
+#
+# an active record model, with mappings inline (could be moved to concern)
+#
+
+  class Foo < ApplicationRecord
+    include Elasticsearch::Model
+    include Lycra::Model
+  end
+
+
+#
+# a document defining mappings, with records backed by a corresponding model
+# and/or
+# an active record model, with mappings defined in a corresponding document
+#
+# this can be a one- or two-way relationship depending on how you want to use it
+
+  class FooDocument
+    include Lycra::Document # or... Lycra::Model::Document to specify a document w/ a backing model?
+  end
+
+  class Foo < ApplicationRecord
+    include Lycra::Document::Model # specify a model backed by a document
+  end
+
+=end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: lycra
 version: !ruby/object:Gem::Version
-  version: 0.0.7
+  version: 5.0.0
 platform: ruby
 authors:
 - Mark Rebec
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-05-27 00:00:00.000000000 Z
+date: 2018-11-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: canfig
@@ -25,27 +25,27 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: elasticsearch
+  name: elasticsearch-model
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.0.18
+        version: '5.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.0.18
+        version: '5.0'
 - !ruby/object:Gem::Dependency
-  name: elasticsearch-persistence
+  name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-  type: :runtime
+  type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
@@ -53,13 +53,13 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: elasticsearch-model
+  name: sqlite3
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-  type: :runtime
+  type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
@@ -67,21 +67,21 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: elasticsearch-rails
+  name: activerecord
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
-  type: :runtime
+        version: '5.0'
+  type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '5.0'
 - !ruby/object:Gem::Dependency
-  name: rake
+  name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -95,7 +95,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: sqlite3
+  name: factory_bot
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -109,7 +109,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: rspec
+  name: faker
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -123,7 +123,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: factory_girl
+  name: byebug
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -137,33 +137,50 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: faker
+  name: awesome_print
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 1.6.6
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 1.6.6
-description: Open source business intelligence based on elasticsearch queries, inspired
-  by https://github.com/ankane/blazer
+        version: '0'
+description: Better elasticsearch documents for ruby
 email:
 - mark@markrebec.com
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- app/documents/lycra/document.rb
+- lib/awesome_print/ext/lycra_attribute.rb
+- lib/awesome_print/ext/lycra_attributes.rb
+- lib/awesome_print/formatters/lycra_attribute_formatter.rb
+- lib/awesome_print/formatters/lycra_attributes_formatter.rb
+- lib/elasticsearch/model/adapters/lycra.rb
+- lib/elasticsearch/model/adapters/lycra/document.rb
+- lib/elasticsearch/model/adapters/lycra/multiple.rb
 - lib/lycra.rb
+- lib/lycra/attributes.rb
+- lib/lycra/attributes/attribute.rb
+- lib/lycra/attributes/collection.rb
+- lib/lycra/awesome_print.rb
+- lib/lycra/decorator.rb
+- lib/lycra/decorator/model.rb
+- lib/lycra/document.rb
+- lib/lycra/document/model.rb
+- lib/lycra/document/proxy.rb
+- lib/lycra/document/registry.rb
 - lib/lycra/engine.rb
 - lib/lycra/errors.rb
-- lib/lycra/model.rb
+- lib/lycra/import.rb
+- lib/lycra/inheritance.rb
 - lib/lycra/monkeypatches.rb
+- lib/lycra/multidoc.rb
 - lib/lycra/search.rb
 - lib/lycra/search/aggregations.rb
 - lib/lycra/search/enumerable.rb
@@ -172,9 +189,13 @@ files:
 - lib/lycra/search/query.rb
 - lib/lycra/search/scoping.rb
 - lib/lycra/search/sort.rb
+- lib/lycra/serializer.rb
+- lib/lycra/serializer/model.rb
+- lib/lycra/types.rb
 - lib/lycra/version.rb
 - spec/lycra_spec.rb
 - spec/spec_helper.rb
+- spec/support/foo.rb
 homepage: http://github.com/markrebec/lycra
 licenses: []
 metadata: {}
@@ -194,10 +215,11 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.6.11
+rubygems_version: 2.7.7
 signing_key: 
 specification_version: 4
-summary: Business intelligence based on elasticsearch queries
+summary: Better elasticsearch documents for ruby
 test_files:
-- spec/lycra_spec.rb
 - spec/spec_helper.rb
+- spec/lycra_spec.rb
+- spec/support/foo.rb

data/app/documents/lycra/document.rb

@@ -1,191 +0,0 @@
-require 'elasticsearch/persistence/model'
-
-module Lycra
-  # TODO explain how this is used, what it is, why, etc.
-
-  # TODO add validations for the results of as_indexed_json against the mapped attributes
-
-  class Document
-    attr_reader :subject
-
-    INDEX_REGEX = /\A#{::Lycra.configuration.index_prefix}-?/
-
-    class << self
-      def inherited(base)
-        # Make sure we inherit the parent's class-level instance variables whenever we inherit from the class.
-        # TODO add more comments/examples explaining why we clone these vars
-        base.send :instance_variable_set, :@lycra_index_name,    index_name.try(:dup)
-        base.send :instance_variable_set, :@lycra_document_type, document_type.try(:dup)
-        base.send :instance_variable_set, :@lycra_attributes,    attributes.try(:dup)
-        base.send :instance_variable_set, :@lycra_mapping,       mapping.try(:dup)
-        base.send :instance_variable_set, :@lycra_settings,      settings.try(:dup)
-      end
-
-      def document_type(doctype=nil)
-        @lycra_document_type = doctype if doctype.present?
-        @lycra_document_type
-      end
-
-      def index_name(zindex_name=nil)
-        @lycra_index_name = prefixed_index_name(zindex_name) if zindex_name.present?
-        @lycra_index_name
-      end
-
-      def attribute(name, type, mappings={})
-        attributes[name] = {type: Elasticsearch::Persistence::Model::Utils.lookup_type(type)}.merge(mappings[:mapping] || {})
-      end
-
-      def attributes(attrs=nil)
-        @lycra_attributes = attrs if attrs.present?
-        @lycra_attributes ||= {}
-      end
-
-      def mapping(map=nil)
-        @lycra_mapping = map if map.present?
-        @lycra_mapping ||= {}
-      end
-      alias_method :mappings, :mapping
-
-      def settings(settings=nil)
-        @lycra_settings = settings if settings.present?
-        @lycra_settings ||= {}
-      end
-
-      def prefixed_index_name(idx)
-        [::Lycra.configuration.index_prefix, idx.to_s.gsub(INDEX_REGEX, '')].compact.join('-')
-      end
-
-      def index_basename
-        index_name.to_s.gsub(INDEX_REGEX, '')
-      end
-
-      def import(*models, **opts, &block)
-        models = [models].flatten
-        document = models.first.lycra_document
-        raise ArgumentError, 'All models must use the same index in order to be imported together' unless models.all? { |model| model.index_name == document.index_name }
-
-        index_name = opts.delete(:index_name) || document.index_name
-
-        if opts.delete(:force) == true && document.__elasticsearch__.client.indices.exists?(index: index_name)
-          # delete the index if it exists and the force-create option was passed
-          document.__elasticsearch__.client.indices.delete index: index_name
-        end
-
-        unless document.__elasticsearch__.client.indices.exists?(index: index_name)
-          document.__elasticsearch__.client.indices.create index: index_name, update_all_types: true, body: {
-            settings: document.settings,
-            mappings: models.inject({}) { |mappings, model| mappings.merge!(model.mappings) } # hacky, need to map all the document mappings
-          }
-        end
-
-        models.each do |model|
-          model.index_name index_name
-          model.import **opts, &block
-          model.index_name document.index_name
-        end
-      end
-
-      def rotate(*models, **opts, &block)
-        models = [models].flatten
-        document = models.first.lycra_document
-        raise ArgumentError, 'All models must use the same index in order to be imported together' unless models.all? { |model| model.index_name == document.index_name }
-
-        unstamped_alias = document.index_name
-        timestamped_index = [unstamped_alias, Time.now.to_i].compact.join('-')
-        existing_index = nil
-
-        import(*models, **opts.merge({index_name: timestamped_index}), &block)
-
-        if document.__elasticsearch__.client.indices.exists_alias? name: unstamped_alias
-          existing_index = document.__elasticsearch__.client.indices.get_alias(name: unstamped_alias).keys.first
-          document.__elasticsearch__.client.indices.delete_alias name: unstamped_alias, index: existing_index
-        elsif document.__elasticsearch__.client.indices.exists? index: unstamped_alias
-          document.__elasticsearch__.client.indices.delete index: unstamped_alias
-        end
-        document.__elasticsearch__.client.indices.put_alias name: unstamped_alias, index: timestamped_index
-        document.__elasticsearch__.client.indices.delete index: existing_index unless existing_index.nil?
-      end
-    end
-
-    # NOTE: HEADS UP! Yes, this is an INSTANCE METHOD!
-    # It is a shortcut, since this class represents both your model **class** (i.e. MyModel) and your model **records** (i.e. MyModel.find(1)).
-    #
-    # normal class usage allows for things like:
-    #
-    # MyDocument.new(MyModel)          # interact with elasticsearch at the model level (index names, mappings, etc.)
-    # MyDocument.new(MyModel.find(1))  # interact with elasticsearch at the record level (as_indexed_json, also has access to index name, etc.)
-    #
-    # but with this, we also get:
-    #
-    # document = MyDocument.new(MyModel)  # instantiate a class-level model document
-    # # ... do some stuff at the class-level ...
-    # document.new(my_model_record)        # easily re-use the same document class to decorate your record without needing to know what it was
-    # # ... do some stuff with your record ...
-    def new(object)
-      self.class.new(object)
-    end
-
-    def initialize(subject)
-      @subject = subject
-
-      if subject.is_a?(Class)
-        # TODO explain why and/or maybe add some ! methods that are more explicit about what we're doing
-        unless self.class.index_name.present?
-          raise Lycra::UndefinedIndexError, self
-        end
-
-        index_name(self.class.index_name)
-        document_type(self.class.document_type)
-        mapping(self.class.mapping)
-        settings(self.class.settings)
-      end
-    end
-
-    def document_type(doctype=nil)
-      subject.__elasticsearch__.document_type doctype
-    end
-
-    def index_name(idx=nil)
-      if idx.present?
-        subject.__elasticsearch__.index_name self.class.prefixed_index_name(idx)
-      else
-        subject.__elasticsearch__.index_name
-      end
-    end
-
-    def mapping(options={}, &block)
-      self.class.attributes.each do |field, opts|
-        subject.__elasticsearch__.mapping.indexes field, opts
-      end
-
-      if options.present? || block_given?
-        subject.__elasticsearch__.mapping options, &block
-      end
-
-      subject.__elasticsearch__.mapping
-    end
-    alias_method :mappings, :mapping
-
-    def settings(settings=nil, &block)
-      subject.__elasticsearch__.settings settings, &block if settings.present? || block_given?
-      subject.__elasticsearch__.settings
-    end
-
-    def method_missing(meth, *args, &block)
-      return subject.send(meth, *args, &block) if respond_to_missing?(meth, true)
-      super
-    end
-
-    def respond_to_missing?(meth, include_private=false)
-      subject.respond_to?(meth, include_private)
-    end
-
-    def as_json(opts={})
-      subject.as_json(opts)
-    end
-
-    def as_indexed_json(opts={})
-      as_json(opts)
-    end
-  end
-end