opt_ar 1.0.0 → 1.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 93053f9644941d1687edc76dec02f9d2dfb64a50f4f0931c4df50b5d83dee276
-  data.tar.gz: 138d399b11b12eac779bb7533c170a1110f8b39c9258cbae618411b5f0ec4441
+  metadata.gz: 05daa8fd91d2473f6cf34e98d2e5ac791f920894ba9320494acf5eda3f8ca0eb
+  data.tar.gz: bfa798775b961b5d4d33c83fd78ca53fef8a7535903e0930c802793b1598f3a8
 SHA512:
-  metadata.gz: 8b8365b6c9e4faf4569c50a76a51403891555b1784546bb67ef051bd3e72eae0ae8002900046c00acbecdeffa4b825f1e6a732480ad1165faff937ff30a0e859
-  data.tar.gz: 69dd6621084a08c33aad785459eb2a44ce2b9b62ce04cd1916e7247312f40b7ce1b3c24200ed3d6eebfb287a790ea9d640dc855ff929f9192cd82eaaecfc1a08
+  metadata.gz: ea64ea8e8691073516396dd1ac53bd90b08c1a1fab8baeaf80d8c3dad2de6bc83f4f5128328246617052f2761755c5b26ef2c2a0f1e0a3317b547ef93dc21944
+  data.tar.gz: 56d26b34be8033148c3452bd77e1177ab80eeb6247dc88ba4a45329e522f86bf76d719ba67ef997abe1471d0916add31fef4231107f93b20e9eddf84d3790ffc

data/.gitignore

@@ -6,3 +6,5 @@
 /pkg/
 /spec/reports/
 /tmp/
+.byebug_history
+/logs/

data/Gemfile

@@ -1,10 +1,16 @@
-source "https://rubygems.org"
+source 'https://rubygems.org'
 
-git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
+git_source(:github) { |repo_name| "https://github.com/#{repo_name}" }
 
 # Specify your gem's dependencies in opt_ar.gemspec
 gemspec
 
 gem 'activerecord', '>= 3.2'
-gem 'mysql2', '>= 0.3 '
-gem 'minitest-reporters'
+
+# gem 'byebug', '10.0.2'
+
+# gem 'minitest-reporters'
+# gem 'minitest-stub-const'
+# gem 'minitest-logger'
+
+gem 'mysql2', '>= 0.3'

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    opt_ar (1.0.0)
+    opt_ar (1.0.1)
       activerecord (>= 3.2)
       mysql2 (>= 0.3)
 
@@ -21,20 +21,13 @@ GEM
       minitest (~> 5.1)
       thread_safe (~> 0.3, >= 0.3.4)
       tzinfo (~> 1.1)
-    ansi (1.5.0)
     arel (6.0.4)
     builder (3.2.3)
     i18n (0.8.1)
     json (1.8.6)
     minitest (5.10.1)
-    minitest-reporters (1.3.5)
-      ansi
-      builder
-      minitest (>= 5.0)
-      ruby-progressbar
     mysql2 (0.4.9)
     rake (10.4.2)
-    ruby-progressbar (1.10.0)
     thread_safe (0.3.6)
     tzinfo (1.2.2)
       thread_safe (~> 0.1)
@@ -46,7 +39,6 @@ DEPENDENCIES
   activerecord (>= 3.2)
   bundler (~> 1.16)
   minitest (~> 5.0)
-  minitest-reporters
   mysql2 (>= 0.3)
   opt_ar!
   rake (~> 10.0)

data/Rakefile

@@ -4,7 +4,7 @@ require 'rake/testtask'
 Rake::TestTask.new(:test) do |t|
   t.libs << 'test'
   t.libs << 'lib'
-  t.test_files = FileList['test/**/*_test.rb']
+  t.test_files = FileList['test/*_test.rb']
 end
 
 task default: :test

data/bin/console

@@ -1,7 +1,10 @@
 #!/usr/bin/env ruby
-
-require "bundler/setup"
-require "opt_ar"
+require 'bundler/setup'
+require 'opt_ar'
+require 'mysql2'
+require 'active_record'
+require 'active_record/connection_adapters/mysql2_adapter'
+require_relative '../test/models/test_models'
 
 # You can add fixtures and/or initialization code here to make experimenting
 # with your gem easier. You can also use a different console, if you like.
@@ -9,6 +12,19 @@ require "opt_ar"
 # (If you use this, don't forget to add pry to your Gemfile!)
 # require "pry"
 # Pry.start
+require 'irb'
+
+ActiveRecord::Base.logger = Logger.new(STDOUT)
+
+ActiveRecord::Base.establish_connection(
+  adapter: 'mysql2',
+  database: 'optar_test',
+  host: 'localhost',
+  username: 'root',
+  password: '',
+  pool: 5
+)
+
+# ActiveRecord::Base.connection_pool.clear_reloadable_connections!
 
-require "irb"
 IRB.start(__FILE__)

data/lib/opt_ar/errors.rb

@@ -14,5 +14,14 @@ module OptAR
 
     class MissingPrimaryKeyError < StandardError
     end
+
+    class NonActiveRecordError < StandardError
+    end
+
+    class PrimaryKeyBlacklistedError < StandardError
+    end
+
+    class TimeTypeExpectedError < StandardError
+    end
   end
 end

data/lib/opt_ar/helpers/method_finder_helper.rb

@@ -1,7 +1,10 @@
 module OptAR
+  # Methods for handling all attributes read
   module MethodFinderHelper
     ID_STRING = 'id'.freeze
     WARN_MSG = 'WARNING :: Trying to access attr that was not requested'.freeze
+    DEFAULT_DATE_TIME_ATTRIBUTES = %i[created_at updated_at].freeze
+    DATE_TIME_CONST_KEY = 'DATE_TIME_ATTRIBUTES'.freeze
 
     private
 
@@ -22,13 +25,14 @@ module OptAR
     #   methods on the instance, for attribute that was not requested initially
     def method_missing(method_name, *args)
       method_name = method_name.to_sym
-      return @attributes[method_name] if @attributes.key?(method_name)
+      return read_from_attributes(method_name) if @attributes.key?(method_name)
 
       raise OptAR::Errors::MissingPrimaryKeyError if primary_key?(method_name)
 
       raise OptAR::Errors::MutationNotAllowedError if assign?(method_name)
 
-      Rails.logger.warn "#{WARN_MSG} :: #{method_name}"
+      OptAR::Logger.log("#{WARN_MSG} :: #{method_name}", :warn)
+
       load_ar_object
       @klass_object ? @klass_object.send(method_name, *args) : super
     end
@@ -42,24 +46,55 @@ module OptAR
       @klass_object.respond_to?(*args)
     end
 
+    def read_from_attributes(key)
+      klass = klass_name.constantize
+      if transformable_fields(klass).include?(key)
+        Time.at(attributes[key]).utc
+      else
+        attributes[key]
+      end
+    end
+
     # Default scope for the class defined by klass_name will be applied here
     def load_ar_object
-      @klass_object ||= klass_name.constantize
-                                  .where(id: id)
-                                  .first(readonly: true)
+      @klass_object ||= begin
+        klass_name.constantize
+                  .readonly(true)
+                  .where("#{klass_primary_key}=#{klass_primary_key_value}")
+                  .first
+      end
       raise OptAR::Errors::ARObjectNotFoundError unless @klass_object
     end
 
+    def transformable_fields(klass)
+      @transformable_keys ||= begin
+        keys = attributes.keys
+        attrs = if klass.const_defined?(DATE_TIME_CONST_KEY)
+                  klass.const_get(DATE_TIME_CONST_KEY)
+                else
+                  DEFAULT_DATE_TIME_ATTRIBUTES
+                end
+        keys & attrs
+      end
+    end
+
     def klass_key
       klass_name.gsub('::', '_').underscore
     end
 
-    def klass_primary_key(klass)
-      klass.primary_key.to_sym
+    def klass_primary_key(klass = nil)
+      @primary_key ||= begin
+        klass ||= klass_name.constantize
+        klass.primary_key.to_sym
+      end
+    end
+
+    def klass_primary_key_value
+      attributes[klass_primary_key]
     end
 
     def primary_key?(method_name)
-      method_name == klass_primary_key(klass_name.constantize)
+      method_name == klass_primary_key
     end
 
     def assign?(method_name)

data/lib/opt_ar/logger.rb

@@ -0,0 +1,17 @@
+module OptAR
+  # Log implementation for the gem
+  #
+  # Tries to use ActiveRecord::Base.logger which is compatible with rails
+  #   else, fallbacks to STDOUT
+  module Logger
+    class << self
+      def log(msg, level = :info)
+        logger.send(level, msg)
+      end
+
+      def logger
+        ActiveRecord::Base.logger || ::Logger.new(STDOUT)
+      end
+    end
+  end
+end

data/lib/opt_ar/{optimal_active_record.rb → oar.rb}

@@ -1,7 +1,14 @@
 require File.dirname(__FILE__) + '/helpers/method_finder_helper'
 
 module OptAR
-  class OptimalActiveRecord
+  # Dupe of ActiveRecord::Base providing necessary read functionalities
+  #   of it, while removing a lot of abstactions that it provides
+  #   to reduce memory and processing time utilisation
+  #
+  # attributes   : contains the requested attributes from AR
+  # klass_name   : class name of original AR model
+  # klass_object : original AR object loaded
+  class OAR
     include OptAR::MethodFinderHelper
 
     attr_reader :attributes, :klass_name, :klass_object
@@ -47,6 +54,7 @@ module OptAR
                        mandatory_attributes(klass) -
                        skipped_attributes(klass)
       @attributes = obj_attributes.slice(*attribute_keys)
+      transform_datetime_attributes(object.class)
     end
 
     def mandatory_attributes(klass)
@@ -59,12 +67,28 @@ module OptAR
     #   security related information to the outside world
     def skipped_attributes(klass)
       if klass.const_defined?(BLACKLISTED_ATTRIBUTES)
-        klass.const_get(BLACKLISTED_ATTRIBUTES)
+        attrs = klass.const_get(BLACKLISTED_ATTRIBUTES)
+        if attrs.include? klass_primary_key(klass)
+          raise OptAR::Errors::PrimaryKeyBlacklistedError
+        end
+        attrs
       else
         []
       end
     end
 
+    def transform_datetime_attributes(klass)
+      fields = transformable_fields(klass)
+      return unless fields.present?
+      fields.each do |field|
+        val = attributes[field]
+        raise OptAR::Errors::TimeTypeExpectedError unless val.is_a?(Time)
+        attributes[field] = val.to_i
+      end
+    ensure
+      attributes.freeze
+    end
+
     def marshal_dump
       [@attributes, @klass_name]
     end

data/lib/opt_ar/optimal_ar/builder.rb

@@ -1,5 +1,5 @@
 require 'active_support/core_ext/kernel/singleton_class'
-require File.dirname(__FILE__) + '/../optimal_active_record'
+require File.dirname(__FILE__) + '/../oar'
 
 module OptAR
   module OptimalAR
@@ -7,59 +7,90 @@ module OptAR
       module ClassMethods
         def build_opt_ar(name, options = {})
           validate_name(name)
+          validate_scope(options[:scope]) if options[:scope]
           faker_proc = lambda do |*args|
-            options = options.respond_to?(:call) ? unscoped { options.call(*args) } : options
+            options = fetch_options(options, *args)
             scope = options[:scope]
-            if scope
-              valid_scope?(scope) ? safe_send(scope).opt_ar_objects(options) : throw_error(:undefined_scope, scope: scope)
-            else
-              safe_send(:build_default_scope).opt_ar_objects(options)
-            end
+            fetch_optar_objects(scope, options)
           end
-          singleton_class.safe_send(:redefine_method, name, &faker_proc)
+          singleton_class.send(:redefine_method, name, &faker_proc)
         end
 
         alias show_as build_opt_ar
 
         private
 
-          def valid_scope?(scope_name)
-            respond_to? scope_name
-          end
+        def validate_scope(scope_name)
+          valid = valid_scope?(scope_name)
+          return if valid == true
+          throw_error(:undefined_scope, scope: scope_name)
+        end
 
-          def validate_name(name)
-            valid = valid_name?(name)
-            throw_error(:invalid_name, name: name, type: valid) unless valid == true
-          end
+        def valid_scope?(scope_name)
+          respond_to? scope_name
+        end
 
-          def valid_name?(name)
-            if !name.is_a?(Symbol)
-              :symbol_expected
-            elsif respond_to? name
-              :duplicate_name
-            else
-              true
-            end
-          end
+        def validate_name(name)
+          valid = valid_name?(name)
+          return true if valid == true
+          throw_error(:invalid_name, name: name, type: valid)
+        end
 
-          def throw_error(error_type, error_options)
-            raise safe_send(error_type, error_options)
+        def valid_name?(name)
+          if !name.is_a?(Symbol)
+            :symbol_expected
+          elsif respond_to? name
+            :duplicate_name
+          else
+            true
           end
+        end
 
-          def undefined_scope(options)
-            Rails.logger.error(" :: show_as defined with Undefined Scope :: #{options[:scope]}")
-            OptAR::Error::UndefinedScopeError.new(options)
+        def fetch_options(options, *args)
+          if options.respond_to?(:call)
+            unscoped { options.call(*args) }
+          else
+            options
           end
+        end
 
-          def invalid_name(options)
-            Rails.logger.error(" :: show_as defined with invalid name :: #{options[:name]} :: #{options[:type]}")
-            OptAR::Error::DuplicateNameError.new(options)
+        def fetch_optar_objects(scope, options)
+          if scope
+            fetch_scoped_optar(scope, options)
+          else
+            fetch_default_scoped_optars(options)
           end
+        end
+
+        def fetch_scoped_optar(scope, options)
+          send(scope).opt_ar_objects(options)
+        end
+
+        def fetch_default_scoped_optars(options)
+          send(:build_default_scope).opt_ar_objects(options)
+        end
+
+        def throw_error(error_type, error_options)
+          raise send(error_type, error_options)
+        end
+
+        def undefined_scope(options)
+          msg = " :: show_as 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}"
+          OptAR::Logger.log(msg, :error)
+          OptAR::Errors::DuplicateNameError.new(options)
+        end
       end
 
       module InstanceMethods
         def opt_ar_object(options = {})
-          OptAR::OptimalActiveRecord.new(self, options)
+          OptAR::OAR.new(self, options)
         end
 
         alias opt_ar_objects opt_ar_object

data/lib/opt_ar/version.rb

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

data/lib/opt_ar.rb

@@ -1,23 +1,50 @@
 require 'opt_ar/version'
 require 'active_record'
 require_relative './opt_ar/optimal_ar/builder'
+require_relative 'opt_ar/logger'
+require_relative 'opt_ar/errors'
 # Dir["#{File.dirname(__FILE__)}/lib/opt_ar/**/*.rb"].each { |f| require f }
 
+# Base module
 module OptAR
 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
   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
   end
 end
 
+# Overwriting Array to make opt_ar_objects 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 { |obj| obj.opt_ar_object(options) }
+    map do |obj|
+      unless obj.is_a? ActiveRecord::Base
+        raise OptAR::Errors::NonActiveRecordError
+      end
+      obj.opt_ar_object(options)
+    end
   end
 end
+
+# TODO: Implement opt_ar_objects for hash
+# class Hash
+#   def opt_ar_objects
+
+#   end
+# end

data/opt_ar.gemspec

@@ -9,15 +9,16 @@ Gem::Specification.new do |spec|
   spec.authors       = ['ragav0102']
   spec.email         = ['ragavh123@gmail.com']
 
-  spec.summary       = 'Generates memory-optimal immutable ActiveRecord dupes'
+  spec.summary       = 'Generates memory-friendly and immutable read-optimized'\
+                       ' ActiveRecord dupes for caching and other purposes'
   spec.description   = 'Generates memory-optimal immutable ActiveRecord dupes '\
                        'that are easily serializable and behaves much like '\
-                       'them. Define required attributes before-hand and use'\
-                       ' them just as you would on an AR, for better memory '\
-                       'optimization.\n Ideally, suitable in place of caching '\
+                       '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'
-  spec.homepage      = "https://github.com/ragav0102/opt_ar"
+  spec.homepage      = 'https://github.com/ragav0102/opt_ar'
   spec.license       = 'MIT'
 
   spec.files         = `git ls-files -z`.split("\x0").reject do |f|

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: opt_ar
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.0.1
 platform: ruby
 authors:
 - ragav0102
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2019-05-01 00:00:00.000000000 Z
+date: 2019-05-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord
@@ -81,10 +81,10 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '10.0'
 description: Generates memory-optimal immutable ActiveRecord dupes that are easily
-  serializable and behaves much like them. Define required attributes before-hand
-  and use them just as you would on an AR, for better memory optimization.\n Ideally,
-  suitable in place of caching AR objects with cache stores like Memcached, where
-  serialization and de-serialization are memory-hungry
+  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
 email:
 - ragavh123@gmail.com
 executables: []
@@ -106,7 +106,8 @@ files:
 - lib/opt_ar/core_ext/array.rb
 - lib/opt_ar/errors.rb
 - lib/opt_ar/helpers/method_finder_helper.rb
-- lib/opt_ar/optimal_active_record.rb
+- lib/opt_ar/logger.rb
+- lib/opt_ar/oar.rb
 - lib/opt_ar/optimal_ar/builder.rb
 - lib/opt_ar/version.rb
 - opt_ar.gemspec
@@ -133,5 +134,6 @@ rubyforge_project:
 rubygems_version: 2.7.5
 signing_key: 
 specification_version: 4
-summary: Generates memory-optimal immutable ActiveRecord dupes
+summary: Generates memory-friendly and immutable read-optimized ActiveRecord dupes
+  for caching and other purposes
 test_files: []