opt_ar 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 93053f9644941d1687edc76dec02f9d2dfb64a50f4f0931c4df50b5d83dee276
+  data.tar.gz: 138d399b11b12eac779bb7533c170a1110f8b39c9258cbae618411b5f0ec4441
+SHA512:
+  metadata.gz: 8b8365b6c9e4faf4569c50a76a51403891555b1784546bb67ef051bd3e72eae0ae8002900046c00acbecdeffa4b825f1e6a732480ad1165faff937ff30a0e859
+  data.tar.gz: 69dd6621084a08c33aad785459eb2a44ce2b9b62ce04cd1916e7247312f40b7ce1b3c24200ed3d6eebfb287a790ea9d640dc855ff929f9192cd82eaaecfc1a08

data/.gitignore

@@ -0,0 +1,8 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/.travis.yml

@@ -0,0 +1,5 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.2.3
+before_install: gem install bundler -v 1.16.1

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at ragavendren.ramachandran@freshworks.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [http://contributor-covenant.org/version/1/4][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/4/

data/Gemfile

@@ -0,0 +1,10 @@
+source "https://rubygems.org"
+
+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'

data/Gemfile.lock

@@ -0,0 +1,55 @@
+PATH
+  remote: .
+  specs:
+    opt_ar (1.0.0)
+      activerecord (>= 3.2)
+      mysql2 (>= 0.3)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    activemodel (4.2.6)
+      activesupport (= 4.2.6)
+      builder (~> 3.1)
+    activerecord (4.2.6)
+      activemodel (= 4.2.6)
+      activesupport (= 4.2.6)
+      arel (~> 6.0)
+    activesupport (4.2.6)
+      i18n (~> 0.7)
+      json (~> 1.7, >= 1.7.7)
+      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)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  activerecord (>= 3.2)
+  bundler (~> 1.16)
+  minitest (~> 5.0)
+  minitest-reporters
+  mysql2 (>= 0.3)
+  opt_ar!
+  rake (~> 10.0)
+
+BUNDLED WITH
+   1.16.1

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2019 ragav0102
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,43 @@
+# OptAR
+
+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.
+
+Ideally, suitable in place of caching AR objects with cache stores like Memcached, where serialization and de-serialization are memory-hungry
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'opt_ar'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install opt_ar
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/opt_ar. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+## Code of Conduct
+
+Everyone interacting in the OptAR project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/opt_ar/blob/master/CODE_OF_CONDUCT.md).

data/Rakefile

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

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "opt_ar"
+
+# 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.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

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

@@ -0,0 +1,7 @@
+module ActiveRecord
+  class Relation
+    def opt_ar_objects(options = {})
+      to_a.opt_ar_objects(options)
+    end
+  end
+end

data/lib/opt_ar/core_ext/array.rb

@@ -0,0 +1,5 @@
+class Array
+  def opt_ar_objects(options = {})
+    map { |obj| obj.opt_ar_object(options) }
+  end
+end

data/lib/opt_ar/errors.rb

@@ -0,0 +1,18 @@
+module OptAR
+  module Errors
+    class UndefinedScopeError < StandardError
+    end
+
+    class DuplicateNameError < StandardError
+    end
+
+    class MutationNotAllowedError < StandardError
+    end
+
+    class ARObjectNotFoundError < StandardError
+    end
+
+    class MissingPrimaryKeyError < StandardError
+    end
+  end
+end

data/lib/opt_ar/helpers/method_finder_helper.rb

@@ -0,0 +1,69 @@
+module OptAR
+  module MethodFinderHelper
+    ID_STRING = 'id'.freeze
+    WARN_MSG = 'WARNING :: Trying to access attr that was not requested'.freeze
+
+    private
+
+    # def attr_reader_proc
+    #   proc.new {
+    #     return @attributes[method_name] if @attributes.key?(method_name)
+    #   }
+    # end
+
+    # Checks for attribute from the attributes hash and returns if found
+    #
+    # Overriding to avoid attributes misses from causing an error
+    # It just throws a warning and proceeds with fetching the actual
+    #   ActiveRecord object,to check for it's response to the method
+    #   defined by name method_name
+    #
+    # Provided only as a fallback for the worst case scenario. Avoid calling
+    #   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)
+
+      raise OptAR::Errors::MissingPrimaryKeyError if primary_key?(method_name)
+
+      raise OptAR::Errors::MutationNotAllowedError if assign?(method_name)
+
+      Rails.logger.warn "#{WARN_MSG} :: #{method_name}"
+      load_ar_object
+      @klass_object ? @klass_object.send(method_name, *args) : super
+    end
+
+    # Introducing this as a best practice when overriding method_missing
+    #
+    # 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)
+      load_ar_object
+      @klass_object.respond_to?(*args)
+    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)
+      raise OptAR::Errors::ARObjectNotFoundError unless @klass_object
+    end
+
+    def klass_key
+      klass_name.gsub('::', '_').underscore
+    end
+
+    def klass_primary_key(klass)
+      klass.primary_key.to_sym
+    end
+
+    def primary_key?(method_name)
+      method_name == klass_primary_key(klass_name.constantize)
+    end
+
+    def assign?(method_name)
+      method_name.to_s.include?('=')
+    end
+  end
+end

data/lib/opt_ar/optimal_active_record.rb

@@ -0,0 +1,76 @@
+require File.dirname(__FILE__) + '/helpers/method_finder_helper'
+
+module OptAR
+  class OptimalActiveRecord
+    include OptAR::MethodFinderHelper
+
+    attr_reader :attributes, :klass_name, :klass_object
+
+    BLACKLISTED_ATTRIBUTES = 'BLACKLISTED_ATTRIBUTES'.freeze
+
+    def initialize(object, options = {})
+      req_attributes = options[:req_attributes] || []
+      assign_attributes(object, req_attributes)
+      @klass_name = object.class.name
+      # define_attr_readers
+    end
+
+    def as_json
+      {
+        klass_key => attributes.as_json
+      }
+    end
+
+    def to_json
+      JSON.dump(as_json)
+    end
+
+    # TODO: for handling JSON serialization
+    def self.from_json(string); end
+
+    private
+
+    # def define_attr_readers
+    #   @attributes.each_pair do |attri, val|
+    #     define_singleton_method attri do
+    #       val
+    #     end
+    #   end
+    # end
+
+    # By default only the primary key will be fetched
+    # Any required attribute has to be called out deliberately
+    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)
+      @attributes = obj_attributes.slice(*attribute_keys)
+    end
+
+    def mandatory_attributes(klass)
+      [klass_primary_key(klass)]
+    end
+
+    # Skips fetching attributes defined by BLACKLISTED_ATTRIBUTES constant
+    #   for the ActiveRecord class
+    # Can be used to prevent exposing attributes having PII, password,
+    #   security related information to the outside world
+    def skipped_attributes(klass)
+      if klass.const_defined?(BLACKLISTED_ATTRIBUTES)
+        klass.const_get(BLACKLISTED_ATTRIBUTES)
+      else
+        []
+      end
+    end
+
+    def marshal_dump
+      [@attributes, @klass_name]
+    end
+
+    def marshal_load(result)
+      @attributes, @klass_name = result
+    end
+  end
+end

data/lib/opt_ar/optimal_ar/builder.rb

@@ -0,0 +1,74 @@
+require 'active_support/core_ext/kernel/singleton_class'
+require File.dirname(__FILE__) + '/../optimal_active_record'
+
+module OptAR
+  module OptimalAR
+    module Builder
+      module ClassMethods
+        def build_opt_ar(name, options = {})
+          validate_name(name)
+          faker_proc = lambda do |*args|
+            options = options.respond_to?(:call) ? unscoped { options.call(*args) } : options
+            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
+          end
+          singleton_class.safe_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_name(name)
+            valid = valid_name?(name)
+            throw_error(:invalid_name, name: name, type: valid) unless valid == true
+          end
+
+          def valid_name?(name)
+            if !name.is_a?(Symbol)
+              :symbol_expected
+            elsif respond_to? name
+              :duplicate_name
+            else
+              true
+            end
+          end
+
+          def throw_error(error_type, error_options)
+            raise safe_send(error_type, error_options)
+          end
+
+          def undefined_scope(options)
+            Rails.logger.error(" :: show_as defined with Undefined Scope :: #{options[:scope]}")
+            OptAR::Error::UndefinedScopeError.new(options)
+          end
+
+          def invalid_name(options)
+            Rails.logger.error(" :: show_as defined with invalid name :: #{options[:name]} :: #{options[:type]}")
+            OptAR::Error::DuplicateNameError.new(options)
+          end
+      end
+
+      module InstanceMethods
+        def opt_ar_object(options = {})
+          OptAR::OptimalActiveRecord.new(self, options)
+        end
+
+        alias opt_ar_objects opt_ar_object
+      end
+
+      def self.included(receiver)
+        receiver.extend         ClassMethods
+        receiver.send :include, InstanceMethods
+      end
+    end
+  end
+end

data/lib/opt_ar/version.rb

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

data/lib/opt_ar.rb

@@ -0,0 +1,23 @@
+require 'opt_ar/version'
+require 'active_record'
+require_relative './opt_ar/optimal_ar/builder'
+# Dir["#{File.dirname(__FILE__)}/lib/opt_ar/**/*.rb"].each { |f| require f }
+
+module OptAR
+end
+
+ActiveRecord::Base.send :include, OptAR::OptimalAR::Builder
+
+module ActiveRecord
+  class Relation
+    def opt_ar_objects(options = {})
+      to_a.opt_ar_objects(options)
+    end
+  end
+end
+
+class Array
+  def opt_ar_objects(options = {})
+    map { |obj| obj.opt_ar_object(options) }
+  end
+end

data/opt_ar.gemspec

@@ -0,0 +1,35 @@
+
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'opt_ar/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'opt_ar'
+  spec.version       = OptAR::VERSION
+  spec.authors       = ['ragav0102']
+  spec.email         = ['ragavh123@gmail.com']
+
+  spec.summary       = 'Generates memory-optimal immutable ActiveRecord dupes'
+  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 '\
+                       'AR objects with cache stores like Memcached, where '\
+                       'serialization and de-serialization are memory-hungry'
+  spec.homepage      = "https://github.com/ragav0102/opt_ar"
+  spec.license       = 'MIT'
+
+  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+  spec.bindir        = 'exe'
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
+
+  spec.add_dependency 'activerecord', '>= 3.2'
+  spec.add_dependency 'mysql2', '>= 0.3'
+  spec.add_development_dependency 'bundler', '~> 1.16'
+  spec.add_development_dependency 'minitest', '~> 5.0'
+  spec.add_development_dependency 'rake', '~> 10.0'
+end

metadata

@@ -0,0 +1,137 @@
+--- !ruby/object:Gem::Specification
+name: opt_ar
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- ragav0102
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2019-05-01 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activerecord
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3.2'
+- !ruby/object:Gem::Dependency
+  name: mysql2
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0.3'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0.3'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !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
+email:
+- ragavh123@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/opt_ar.rb
+- lib/opt_ar/core_ext/active_record/relation.rb
+- 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/optimal_ar/builder.rb
+- lib/opt_ar/version.rb
+- opt_ar.gemspec
+homepage: https://github.com/ragav0102/opt_ar
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.7.5
+signing_key: 
+specification_version: 4
+summary: Generates memory-optimal immutable ActiveRecord dupes
+test_files: []