opt_ar 1.0.1 → 1.1.0

data/benchmarks/employee_creation.rb

@@ -0,0 +1,16 @@
+10_000.times do |n|
+  time = (n % 3_000).days.ago
+  time1 = ((n + rand(32)) % 3_000).days.ago
+  e = Employee.new(
+    emp_id: (13_001 + n),
+    first_name: (0...6).map { ('a'..'z').to_a[rand(26)] }.join,
+    last_name: (0...6).map { ('a'..'z').to_a[rand(26)] }.join,
+    birth_date: time1.to_date,
+    hire_date: time.to_date,
+    created_at: time,
+    updated_at: time + 1000,
+    gender: n % 2,
+    password: (0...9).map { ('a'..'z').to_a[rand(26)] }.join
+  )
+  e.save
+end

data/lib/opt_ar.rb

@@ -3,6 +3,9 @@ require 'active_record'
 require_relative './opt_ar/optimal_ar/builder'
 require_relative 'opt_ar/logger'
 require_relative 'opt_ar/errors'
+require_relative 'opt_ar/core_ext/active_record/relation'
+require_relative 'opt_ar/core_ext/array'
+# Dir['/opt_ar/core_ext/*/*.rb'].each { |file| require file }
 # Dir["#{File.dirname(__FILE__)}/lib/opt_ar/**/*.rb"].each { |f| require f }
 
 # Base module
@@ -12,39 +15,22 @@ end
 ActiveRecord::Base.send :include, OptAR::OptimalAR::Builder
 
 module ActiveRecord
-  # Overwriting ActiveRecord::Relation to make opt_ar_objects
-  #   method available for all relations, returning array of
-  #   `OAR`s which we generate
+  # Extending ActiveRecord::Relation to respond to optars
   class Relation
-    # TODO: Introduce pluck usage for relations
-    # if ActiveRecord::VERSION::MAJOR < 4
-    #   to_a.opt_ar_objects(options)
-    # else
-    #   pluck(options[:req_attributes]).opt_ar_objects
-    # end
-    def opt_ar_objects(options = {})
-      to_a.opt_ar_objects(options)
-    end
+    include ActiveRecord::RelationExtender
   end
 end
 
-# Overwriting Array to make opt_ar_objects method available
+# Overwriting Array to make optars method available
 #   for all arrays containing ActiveRecord::Base objects, returning
 #   an array of `OAR`s which we generate
 class Array
-  def opt_ar_objects(options = {})
-    map do |obj|
-      unless obj.is_a? ActiveRecord::Base
-        raise OptAR::Errors::NonActiveRecordError
-      end
-      obj.opt_ar_object(options)
-    end
-  end
+  include ArrayExtender
 end
 
-# TODO: Implement opt_ar_objects for hash
+# TODO: Implement optars for hash
 # class Hash
-#   def opt_ar_objects
+#   def optars
 
 #   end
 # end

data/lib/opt_ar/core_ext/active_record/relation.rb

@@ -1,7 +1,47 @@
 module ActiveRecord
-  class Relation
-    def opt_ar_objects(options = {})
-      to_a.opt_ar_objects(options)
+  # Adding functionality to ActiveRecord::Relation to make
+  #   optars method available for all relations,
+  #   returning array of `OAR`s which we generate
+  module RelationExtender
+    DEFAULT_QUERY_OPTIONS = {
+      symbolize_keys:    true,  # Returns attributes with symbolized keys
+      as:                :hash, # Returns rows as Hash objects
+      cast_booleans:     true,  # Typecasts TINYINT columns
+      database_timezone: ActiveRecord::Base.default_timezone,
+      cache_rows:        false
+      # Disabled because iteration happens only once allowing GC to cleanup
+    }.freeze
+
+    def optars(options = {})
+      attrs = options[:attrs] || []
+      validate_columns(attrs)
+      select_attrs = ([primary_key] + attrs).uniq
+      sql_query = except(:select).select(select_attrs).to_sql
+      fetch_objects(sql_query, select_attrs)
+    end
+
+    alias opt_ar_objects optars
+
+    private
+
+    def fetch_objects(query, requested_attributes)
+      res = fetch_sql_rows(query, DEFAULT_QUERY_OPTIONS)
+      res.map do |row|
+        OptAR::OAR.init_manual(row, klass, requested_attributes)
+      end
+    end
+
+    def fetch_sql_rows(query, options)
+      client = connection.raw_connection
+      connection.send(:log, query, "OptAR - #{klass.name}") do
+        client.query(query, options)
+      end
+    end
+
+    def validate_columns(attrs)
+      klass_attrs = klass.column_names.map(&:to_sym)
+      valid = (attrs - klass_attrs).empty?
+      raise OptAR::Errors::UnknownARColumnError unless valid
     end
   end
 end

data/lib/opt_ar/core_ext/array.rb

@@ -1,5 +1,15 @@
-class Array
-  def opt_ar_objects(options = {})
-    map { |obj| obj.opt_ar_object(options) }
+# Extender to add functionality to Array class to make optars
+#   method available for an array of ActiveRecord objects,
+#   returning array of `OAR`s which we generate
+module ArrayExtender
+  def optars(options = {})
+    map do |obj|
+      unless obj.is_a? ActiveRecord::Base
+        raise OptAR::Errors::NonActiveRecordError
+      end
+      obj.optar(options)
+    end
   end
+
+  alias opt_ar_objects optars
 end

data/lib/opt_ar/errors.rb

@@ -23,5 +23,11 @@ module OptAR
 
     class TimeTypeExpectedError < StandardError
     end
+
+    class MandatoryPrimaryKeyMissingError < StandardError
+    end
+
+    class UnknownARColumnError < StandardError
+    end
   end
 end

data/lib/opt_ar/helpers/method_finder_helper.rb

@@ -42,6 +42,9 @@ module OptAR
     # Be cautious of using respond_to? as this will try to query for the
     #   actual ActiveRecord object and check for it's response
     def respond_to_missing?(*args)
+      method_name = args[0]
+      return true if @attributes.key?(method_name)
+
       load_ar_object
       @klass_object.respond_to?(*args)
     end

data/lib/opt_ar/oar.rb

@@ -16,12 +16,22 @@ module OptAR
     BLACKLISTED_ATTRIBUTES = 'BLACKLISTED_ATTRIBUTES'.freeze
 
     def initialize(object, options = {})
-      req_attributes = options[:req_attributes] || []
+      req_attributes = options[:attrs] || []
       assign_attributes(object, req_attributes)
       @klass_name = object.class.name
       # define_attr_readers
     end
 
+    def self.init_manual(attrs, klass, req_attributes)
+      oar = allocate
+      attr_keys = oar.send(:fetch_attribute_keys, req_attributes, klass)
+      attrs = attrs.slice(*attr_keys)
+      oar.instance_variable_set('@attributes', attrs)
+      oar.instance_variable_set('@klass_name', klass.name)
+      oar.send(:transform_datetime_attributes, klass)
+      oar
+    end
+
     def as_json
       {
         klass_key => attributes.as_json
@@ -50,13 +60,21 @@ module OptAR
     def assign_attributes(object, req_attributes)
       obj_attributes = object.attributes.symbolize_keys
       klass = object.class
-      attribute_keys = req_attributes +
-                       mandatory_attributes(klass) -
-                       skipped_attributes(klass)
+      p_key = klass_primary_key(klass)
+
+      unless obj_attributes[p_key]
+        raise OptAR::Errors::MandatoryPrimaryKeyMissingError
+      end
+
+      attribute_keys = fetch_attribute_keys(req_attributes, klass)
       @attributes = obj_attributes.slice(*attribute_keys)
       transform_datetime_attributes(object.class)
     end
 
+    def fetch_attribute_keys(req_attributes, klass)
+      req_attributes + mandatory_attributes(klass) - skipped_attributes(klass)
+    end
+
     def mandatory_attributes(klass)
       [klass_primary_key(klass)]
     end

data/lib/opt_ar/optimal_ar/builder.rb

@@ -5,18 +5,17 @@ module OptAR
   module OptimalAR
     module Builder
       module ClassMethods
-        def build_opt_ar(name, options = {})
+        def build_optar(name, options = {})
           validate_name(name)
           validate_scope(options[:scope]) if options[:scope]
           faker_proc = lambda do |*args|
-            options = fetch_options(options, *args)
-            scope = options[:scope]
-            fetch_optar_objects(scope, options)
+            fetch_optar_objects(options[:scope], options)
           end
           singleton_class.send(:redefine_method, name, &faker_proc)
         end
 
-        alias show_as build_opt_ar
+        alias swindle build_optar
+        alias show_as build_optar
 
         private
 
@@ -37,23 +36,13 @@ module OptAR
         end
 
         def valid_name?(name)
-          if !name.is_a?(Symbol)
-            :symbol_expected
-          elsif respond_to? name
+          if respond_to? name
             :duplicate_name
           else
             true
           end
         end
 
-        def fetch_options(options, *args)
-          if options.respond_to?(:call)
-            unscoped { options.call(*args) }
-          else
-            options
-          end
-        end
-
         def fetch_optar_objects(scope, options)
           if scope
             fetch_scoped_optar(scope, options)
@@ -63,11 +52,11 @@ module OptAR
         end
 
         def fetch_scoped_optar(scope, options)
-          send(scope).opt_ar_objects(options)
+          send(scope).optars(options)
         end
 
         def fetch_default_scoped_optars(options)
-          send(:build_default_scope).opt_ar_objects(options)
+          send(:build_default_scope).optars(options)
         end
 
         def throw_error(error_type, error_options)
@@ -75,25 +64,27 @@ module OptAR
         end
 
         def undefined_scope(options)
-          msg = " :: show_as defined with Undefined Scope :: #{options[:scope]}"
+          msg = " :: swindle defined with Undefined Scope :: #{options[:scope]}"
           OptAR::Logger.log(msg, :error)
           OptAR::Errors::UndefinedScopeError.new(options)
         end
 
         def invalid_name(options)
           error_options = "#{options[:name]} :: #{options[:type]}"
-          msg = " :: show_as defined with invalid name :: #{error_options}"
+          msg = " :: swindle defined with invalid name :: #{error_options}"
           OptAR::Logger.log(msg, :error)
           OptAR::Errors::DuplicateNameError.new(options)
         end
       end
 
       module InstanceMethods
-        def opt_ar_object(options = {})
+        def optar(options = {})
           OptAR::OAR.new(self, options)
         end
 
-        alias opt_ar_objects opt_ar_object
+        alias optars optar
+        alias opt_ar_objects optar
+        alias opt_ar_object optar
       end
 
       def self.included(receiver)

data/lib/opt_ar/version.rb

@@ -1,3 +1,3 @@
 module OptAR
-  VERSION = '1.0.1'.freeze
+  VERSION = '1.1.0'.freeze
 end

data/opt_ar.gemspec

@@ -17,7 +17,10 @@ Gem::Specification.new do |spec|
                        'them just as you would on an AR, for better memory '\
                        'optimization. Ideally, suitable in place of caching '\
                        'AR objects with cache stores like Memcached, where '\
-                       'serialization and de-serialization are memory-hungry'
+                       'serialization and de-serialization are memory-hungry. '\
+                       'Optars can save upto 90% of your memory(object '\
+                       'allocations), while being upto 20x faster, when '\
+                       'fetching huge AR results.'
   spec.homepage      = 'https://github.com/ragav0102/opt_ar'
   spec.license       = 'MIT'
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: opt_ar
 version: !ruby/object:Gem::Version
-  version: 1.0.1
+  version: 1.1.0
 platform: ruby
 authors:
 - ragav0102
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2019-05-04 00:00:00.000000000 Z
+date: 2019-05-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord
@@ -84,13 +84,16 @@ description: Generates memory-optimal immutable ActiveRecord dupes that are easi
   serializable and behaves much like ARs. Define required attributes before-hand and
   use them just as you would on an AR, for better memory optimization. Ideally, suitable
   in place of caching AR objects with cache stores like Memcached, where serialization
-  and de-serialization are memory-hungry
+  and de-serialization are memory-hungry. Optars can save upto 90% of your memory(object
+  allocations), while being upto 20x faster, when fetching huge AR results.
 email:
 - ragavh123@gmail.com
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".circleci/config.yml"
+- ".coveralls.yml"
 - ".gitignore"
 - ".travis.yml"
 - CODE_OF_CONDUCT.md
@@ -99,6 +102,13 @@ files:
 - LICENSE.txt
 - README.md
 - Rakefile
+- benchmarks/benchmark_1.rb
+- benchmarks/benchmark_2.rb
+- benchmarks/benchmark_3.rb
+- benchmarks/benchmark_4.rb
+- benchmarks/benchmark_5.rb
+- benchmarks/benchmark_6.rb
+- benchmarks/employee_creation.rb
 - bin/console
 - bin/setup
 - lib/opt_ar.rb