opt_ar 1.0.1 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 05daa8fd91d2473f6cf34e98d2e5ac791f920894ba9320494acf5eda3f8ca0eb
-  data.tar.gz: bfa798775b961b5d4d33c83fd78ca53fef8a7535903e0930c802793b1598f3a8
+  metadata.gz: 9bf739c60e437c0a17f2615dc5ab31001856006fdf2f6aee4cc2fd6ef6499219
+  data.tar.gz: d943d7dd7b81ad90ac7c8c5486afbbe81ccd42435704c7dbc07ebc761e1a9da6
 SHA512:
-  metadata.gz: ea64ea8e8691073516396dd1ac53bd90b08c1a1fab8baeaf80d8c3dad2de6bc83f4f5128328246617052f2761755c5b26ef2c2a0f1e0a3317b547ef93dc21944
-  data.tar.gz: 56d26b34be8033148c3452bd77e1177ab80eeb6247dc88ba4a45329e522f86bf76d719ba67ef997abe1471d0916add31fef4231107f93b20e9eddf84d3790ffc
+  metadata.gz: 8136acee5dd7dc95e9f7291223e99da527ad2a19d2b277bc5b6fba710c8140e816d93cb9b02e903b2b584ba9d11493f82a57e76b038568192c22324ba4bd94b3
+  data.tar.gz: 38ed562be1053fc966d12fc51496bd93117931407b3d11b1bd7d20203800a05c5f5750d6c2dbfb365fdd3d89a3a6972202312c1808f1129463825fc30de61951

data/.circleci/config.yml

@@ -0,0 +1,51 @@
+# Ruby CircleCI 2.0 configuration file
+#
+version: 2
+jobs:
+  build:
+    docker:
+      - image: spittet/ruby-mysql
+
+    environment:
+      COVERALLS_REPO_TOKEN: coverallsRepoToken
+
+    working_directory: ~/repo
+
+    steps:
+      - checkout
+
+      - run:
+          name: upgrade bundler
+          command:
+            gem install bundler -v 1.16.1
+
+      - run:
+          name: install dependencies
+          command:
+            bundle install --jobs=4 --retry=3 --path vendor/bundle
+
+      # Database setup
+      - run:
+          name: start mysql
+          command:
+            /etc/init.d/mysql start
+
+      - run: bundle exec rake db:create
+
+      # run tests!
+      - run:
+          name: run tests
+          command:
+            COVERALLS_REPO_TOKEN=$COVERALLS_REPO_TOKEN rake test
+
+      - run:
+          name: push result data to coveralls
+          command:
+            bundle exec rake coveralls:push
+
+      - store_test_results:
+          path: tmp/test-results
+
+      - store_artifacts:
+          path: tmp/test-results
+          destination: test-results

data/.coveralls.yml

@@ -0,0 +1 @@
+service name: circleci

data/.gitignore

@@ -8,3 +8,5 @@
 /tmp/
 .byebug_history
 /logs/
+*.log
+/coverage/

data/Gemfile

@@ -9,8 +9,18 @@ gem 'activerecord', '>= 3.2'
 
 # gem 'byebug', '10.0.2'
 
-# gem 'minitest-reporters'
-# gem 'minitest-stub-const'
-# gem 'minitest-logger'
+gem 'minitest-reporters'
+gem 'minitest-stub-const'
 
 gem 'mysql2', '>= 0.3'
+
+gem 'benchmark-ips'
+gem 'benchmark-memory'
+
+gem 'simplecov'
+gem 'simplecov-console'
+gem 'coveralls', require: false
+
+# gem 'codeclimate-test-reporter'
+
+gem 'minitest-ci'

data/Gemfile.lock

@@ -1,35 +1,75 @@
 PATH
   remote: .
   specs:
-    opt_ar (1.0.1)
+    opt_ar (1.1.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)
+    activemodel (5.2.3)
+      activesupport (= 5.2.3)
+    activerecord (5.2.3)
+      activemodel (= 5.2.3)
+      activesupport (= 5.2.3)
+      arel (>= 9.0)
+    activesupport (5.2.3)
+      concurrent-ruby (~> 1.0, >= 1.0.2)
+      i18n (>= 0.7, < 2)
       minitest (~> 5.1)
-      thread_safe (~> 0.3, >= 0.3.4)
       tzinfo (~> 1.1)
-    arel (6.0.4)
+    ansi (1.5.0)
+    arel (9.0.0)
+    benchmark-ips (2.7.2)
+    benchmark-memory (0.1.2)
+      memory_profiler (~> 0.9)
     builder (3.2.3)
-    i18n (0.8.1)
-    json (1.8.6)
-    minitest (5.10.1)
-    mysql2 (0.4.9)
-    rake (10.4.2)
+    concurrent-ruby (1.1.5)
+    coveralls (0.7.2)
+      multi_json (~> 1.3)
+      rest-client (= 1.6.7)
+      simplecov (>= 0.7)
+      term-ansicolor (= 1.2.2)
+      thor (= 0.18.1)
+    docile (1.1.5)
+    hirb (0.7.3)
+    i18n (1.5.1)
+      concurrent-ruby (~> 1.0)
+    memory_profiler (0.9.12)
+    mime-types (3.2.2)
+      mime-types-data (~> 3.2015)
+    mime-types-data (3.2019.0331)
+    minitest (5.11.3)
+    minitest-ci (3.4.0)
+      minitest (>= 5.0.6)
+    minitest-reporters (1.3.6)
+      ansi
+      builder
+      minitest (>= 5.0)
+      ruby-progressbar
+    minitest-stub-const (0.6)
+    multi_json (1.13.1)
+    mysql2 (0.5.2)
+    rake (10.5.0)
+    rest-client (1.6.7)
+      mime-types (>= 1.16)
+    ruby-progressbar (1.10.0)
+    simplecov (0.8.2)
+      docile (~> 1.1.0)
+      multi_json
+      simplecov-html (~> 0.8.0)
+    simplecov-console (0.4.2)
+      ansi
+      hirb
+      simplecov
+    simplecov-html (0.8.0)
+    term-ansicolor (1.2.2)
+      tins (~> 0.8)
+    thor (0.18.1)
     thread_safe (0.3.6)
-    tzinfo (1.2.2)
+    tins (0.13.2)
+    tzinfo (1.2.5)
       thread_safe (~> 0.1)
 
 PLATFORMS
@@ -37,11 +77,19 @@ PLATFORMS
 
 DEPENDENCIES
   activerecord (>= 3.2)
+  benchmark-ips
+  benchmark-memory
   bundler (~> 1.16)
+  coveralls
   minitest (~> 5.0)
+  minitest-ci
+  minitest-reporters
+  minitest-stub-const
   mysql2 (>= 0.3)
   opt_ar!
   rake (~> 10.0)
+  simplecov
+  simplecov-console
 
 BUNDLED WITH
    1.16.1

data/README.md

@@ -1,8 +1,9 @@
 # OptAR
+[![CircleCI](https://circleci.com/gh/ragav0102/opt_ar/tree/master.svg?style=svg)](https://circleci.com/gh/ragav0102/opt_ar/tree/master) [![Coverage Status](https://coveralls.io/repos/github/ragav0102/opt_ar/badge.svg?branch=master)](https://coveralls.io/github/ragav0102/opt_ar?branch=master) [![Gem Version](https://badge.fury.io/rb/opt_ar.svg)](https://badge.fury.io/rb/opt_ar) ![](https://ruby-gem-downloads-badge.herokuapp.com/opt_ar?type=total&style=plastic&color=brightgreen&total_label=)
 
-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.
+Generates memory-optimal immutable ActiveRecord dupes that are easily serializable and behaves much like ARs. Request attributes that will be read before-hand, and use them later 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
+Ideally, suitable in place of caching AR objects with cache stores like Memcached, where 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.
 
 ## Installation
 
@@ -22,17 +23,146 @@ Or install it yourself as:
 
 ## Usage
 
-TODO: Write usage instructions here
+Declare OptAR scopes for an ActiveRecord model like below
+
+```ruby
+class Employee < ActiveRecord::Base
+  self.table_name =  'employee'.freeze
+  self.primary_key = 'emp_id'.freeze
+
+
+  scope :male_employees, lambda {
+    where(gender: 1)
+  }
+
+  swindle :male_names,
+          scope: :male_employees,
+          attrs: %i[emp_id first_name last_name]
+
+  swindle :emp_birth_dates
+          attrs: %i[birth_date]
+
+  swindle :all_emp_ids
+end
+```
+
+  * **scope**          - You can use a predefined scope/association.
+
+If not given, gets the default scope for the model
+
+
+  * **attrs** - Request attributes that will be read later. Reading unrequested attributes is an **anti-pattern**.
+
+If not given, stores only the primary key
+   
+```ruby
+ > emp = Employee.male_names
+ # [#<OptAR::OAR:0x007fe5d1dc1dd8 @attributes={:emp_id=>10082, :first_name=>"Parviz", :last_name=>"Lortz"}, @klass_name="Employee">, #<OptAR::OAR:0x007fe5d1dc1810 @attributes={:emp_id=>10096, :first_name=>"Jayson", :last_name=>"Mandell"}, @klass_name="Employee">,..]
+
+ > emp.first.first_name
+ # => "Parviz"
+ 
+ > emp.first.birth_date
+ # WARNING :: Trying to access attr that was not requested :: birth_date
+ # Employee Load (1.1ms)  SELECT  `employee`.* FROM `employee` WHERE emp_id=10082 LIMIT 1
+ # => Mon, 09 Sep 1963
+```
+
+---
+
+> Things to remember:
+> - All OAR objects are immutable. Trying to write or change it will raise exceptions.
+> - Again, OARs are __read-optimized__ AR dupes
+> - Utilize it better for querying/caching, by defining attributes, only that are required
+
+
+---
+
+
+Use them on _AR relations/ Array of ARs_ as well
+
+```ruby
+ > rel = Employee.all
+ 
+ > rel.optars
+ # => [#<OptAR::OAR:0x007fe5d11f2b88 @attributes={:emp_id=>10082}, @klass_name="Employee">, #<OptAR::OAR:0x007fe5d11f25c0 @attributes={:emp_id=>10096}, @klass_name="Employee">,..]
+ 
+ > arr = rel.to_a
+ # => [#<OptAR::OAR:0x007fe5d11885f8 @attributes={:emp_id=>10082}, @klass_name="Employee">, #<OptAR::OAR:0x007fe5d11939a8  @attributes={:emp_id=>10096}, @klass_name="Employee">,..]
+
+ > arr.optars(attrs: [:first_name])
+ # => [#<OptAR::OAR:0x007fe5d0953400 @attributes={:first_name=>"Parviz", :emp_id=>10082}, @klass_name="Employee">, #<OptAR::OAR:0x007fe5d09530b8 @attributes={:first_name=>"Jayson", :emp_id=>10096}, @klass_name="Employee">,..]
+ 
+```
+
+---
+
+
+On an ActiveRecord,
+
+```ruby
+
+> emp = Employee.first
+
+> emp.optar(attrs: [:last_name, :birth_date])
+# => #<OptAR::OAR:0x007fe5d096d558 @attributes={:last_name=>"Lortz", :birth_date=>Mon, 09 Sep 1963, :emp_id=>10082}, @klass_name="Employee">
+
+```
+---
+
+
+_created_at_ and _updated_at_ fields are by default considered to be Time objects. Override them using the _const_,
+
+```ruby
+    DATE_TIME_ATTRIBUTES = %i[last_login_time]
+```
+in your model.
+
+
+ * Why do I need to do this?
+
+  Beleive me, this will spare some memory for you.
+  
+---
+
+
+Restrict storing sensitive/PII info outside, by blacklisting them. Simply add this _const_ to your model
+
+```ruby
+    BLACKLISTED_ATTRIBUTES = %i[password persist_token]
+```
+
+---
+
+## Benchmarks
+
+Benchmark results for executing selects, marshal dumping and loads on ActiveRecord vs Optars are as follows:
+
+| | Execution time | Memory saved |
+|-|:----------------:|:--------------:|
+| Select queries | 2-4x faster | 20-70%|
+| Dumps | 2-6x faster | 30-80%|
+| Loads | 5-20x faster | 70-90% |
+
+_* Larger the data, greater the results_
+
+
+Common caching solutions like Memcached by default, uses Marshalling to store and retrieve objects. Storing and retrieving AR objects, creates a lot of ruby objects in memory, which grows linearly with the number of ARs.
+
+_Optars_ are here to save you, use them well.
+
+Scripts used for benchmarking can be found inside benchmarks [folder](./benchmarks).
+
+
+
 
 ## 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.
+Bug reports and pull requests are welcome on GitHub at https://github.com/ragav0102/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
 
@@ -40,4 +170,8 @@ The gem is available as open source under the terms of the [MIT License](https:/
 
 ## 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).
+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/ragav0102/opt_ar/blob/master/CODE_OF_CONDUCT.md).
+
+
+
+Available at https://rubygems.org/gems/opt_ar

data/Rakefile

@@ -1,5 +1,9 @@
 require 'bundler/gem_tasks'
 require 'rake/testtask'
+require 'mysql2'
+require 'active_record'
+require 'active_record/connection_adapters/mysql2_adapter'
+require 'coveralls/rake/task'
 
 Rake::TestTask.new(:test) do |t|
   t.libs << 'test'
@@ -7,4 +11,22 @@ Rake::TestTask.new(:test) do |t|
   t.test_files = FileList['test/*_test.rb']
 end
 
+namespace :db do
+  task :create do
+    ActiveRecord::Base.establish_connection(
+      adapter: 'mysql2',
+      host: 'localhost',
+      username: 'root',
+      password: '',
+      pool: 5
+    )
+
+    conn = ActiveRecord::Base.connection
+    create_db = 'CREATE DATABASE optar_test'
+    conn.execute(create_db)
+  end
+end
+
 task default: :test
+
+Coveralls::RakeTask.new

data/benchmarks/benchmark_1.rb

@@ -0,0 +1,131 @@
+require 'benchmark/memory'
+
+def bm_time
+  old_logger = ActiveRecord::Base.logger
+  ActiveRecord::Base.logger = nil
+  Benchmark.bm(12) do |x|
+    x.report('AR') do
+      emp = Employee.all.to_a
+      emp.last.emp_id
+    end
+
+    x.report('AR select') do
+      emp = Employee.all.select(%i[emp_id first_name last_name created_at]).to_a
+      emp.last.emp_id
+    end
+
+    x.report('OptAR') do
+      emp = Employee.all.optars
+      emp.last.emp_id
+    end
+
+    x.report('OptAR req') do
+      emp = Employee.all.optars(
+        req_attribute: %i[emp_id first_name last_name created_at]
+      )
+      emp.last.emp_id
+    end
+  end
+  ActiveRecord::Base.logger = old_logger
+
+  nil
+end
+
+def bm_mem
+  old_logger = ActiveRecord::Base.logger
+  ActiveRecord::Base.logger = nil
+
+  Benchmark.memory do |x|
+    x.compare!
+    x.report('AR') do
+      emp = Employee.all.to_a
+      emp.last.emp_id
+    end
+
+    x.report('AR select') do
+      emp = Employee.all.select(%i[emp_id first_name last_name created_at]).to_a
+      emp.last.emp_id
+    end
+
+    x.report('OptAR') do
+      emp = Employee.all.optars
+      emp.last.emp_id
+    end
+
+    x.report('OptAR req') do
+      emp = Employee.all.optars(
+        req_attribute: %i[emp_id first_name last_name created_at]
+      )
+      emp.last.emp_id
+    end
+  end
+  ActiveRecord::Base.logger = old_logger
+
+  nil
+end
+
+bm_time
+
+bm_mem
+
+# 1042 objects:
+#                   AR     2.173M memsize (     1.208k retained)
+#                         22.114k objects (     1.000  retained)
+#                         50.000  strings (     0.000  retained)
+#            AR select     1.326M memsize (     1.208k retained)
+#                         15.938k objects (     1.000  retained)
+#                         50.000  strings (     0.000  retained)
+#                OptAR     1.054M memsize (     1.208k retained)
+#                         14.840k objects (     1.000  retained)
+#                         19.000  strings (     0.000  retained)
+#            OptAR req     1.054M memsize (     1.208k retained)
+#                         14.841k objects (     1.000  retained)
+#                         19.000  strings (     0.000  retained)
+
+# Comparison:
+#                OptAR:    1053649 allocated
+#            OptAR req:    1053913 allocated - 1.00x more
+#            AR select:    1326421 allocated - 1.26x more
+#                   AR:    2172969 allocated - 2.06x more
+
+#                    user     system      total        real
+# AR             0.020000   0.000000   0.020000 (  0.028664)
+# AR select      0.020000   0.000000   0.020000 (  0.022151)
+# OptAR          0.010000   0.000000   0.010000 (  0.010412)
+# OptAR req      0.010000   0.000000   0.010000 (  0.010862)
+
+# AR             0.020000   0.000000   0.020000 (  0.029021)
+# AR select      0.030000   0.000000   0.030000 (  0.028373)
+# OptAR          0.010000   0.000000   0.010000 (  0.012695)
+# OptAR req      0.010000   0.000000   0.010000 (  0.011037)
+
+# 11042 objects:
+#                   AR    22.809M memsize (     1.208k retained)
+#                        232.114k objects (     1.000  retained)
+#                         50.000  strings (     0.000  retained)
+#            AR select    13.802M memsize (     1.208k retained)
+#                        165.938k objects (     1.000  retained)
+#                         50.000  strings (     0.000  retained)
+#                OptAR    10.972M memsize (     1.208k retained)
+#                        154.840k objects (     1.000  retained)
+#                         19.000  strings (     0.000  retained)
+#            OptAR req    10.972M memsize (     1.208k retained)
+#                        154.841k objects (     1.000  retained)
+#                         19.000  strings (     0.000  retained)
+
+# Comparison:
+#                OptAR:   10971521 allocated
+#            OptAR req:   10971785 allocated - 1.00x more
+#            AR select:   13802165 allocated - 1.26x more
+#                   AR:   22808713 allocated - 2.08x more
+
+#                    user     system      total        real
+# AR             0.210000   0.010000   0.220000 (  0.235152)
+# AR select      0.200000   0.010000   0.210000 (  0.217465)
+# OptAR          0.090000   0.000000   0.090000 (  0.105298)
+# OptAR req      0.070000   0.010000   0.080000 (  0.088627)
+
+# AR             0.210000   0.010000   0.220000 (  0.235152)
+# AR select      0.200000   0.010000   0.210000 (  0.217465)
+# OptAR          0.090000   0.000000   0.090000 (  0.105298)
+# OptAR req      0.070000   0.010000   0.080000 (  0.088627)