rearmed 1.0.0 → 1.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 8fa0d5cedc04978a85f2c4a0fb6513c901433e91
-  data.tar.gz: 1bdae7cb97e455015685cb4892d8efbbf979d7ad
+  metadata.gz: 4b89bebeea7547a401cc55438789b46e09e82177
+  data.tar.gz: eb9048e4ee97652b778d424422969c3e73e6924e
 SHA512:
-  metadata.gz: 2d5e3761d13a41c5fad2891d6c06b012e718466ae2ac2134bb16d8f140f143bb7835913dff9d79f5516fa33887623c2f37c42c45d8f7fa84c1e00236f7d0f152
-  data.tar.gz: fe28bd2d924cc1af47222b82e69ba4ba1aefd8c154e0486b27ee0aadd51415c8cfb335b025756ed0c9056465f655868ae329860196c3c2b3511dfecc2e47e536
+  metadata.gz: 2d5d35e487207fe314f491965e7d9732b675da554dc49657dca0850aba11507aa681d50c3b75c3fde090c20f75edbf763f654363a239087a682c47e700f7a4f3
+  data.tar.gz: ad301662615d17735b59308291751a728ffa4fc24c306cb21c676c2b6fa0b9a37650f37f349b08272597bc92615b384ba41f1fb2cc8e64427380892e0c7912f8

data/CHANGELOG.md

@@ -1,8 +1,12 @@
 CHANGELOG
 ---------
 
-- **June.02.2016**: 0.9.1
+- **1.0.0 - June 8, 2016**
+  - Ready for public use
+  - Major improvements to opt-in system
+  - Move some methods to Rearmed for use outside of monkey patching
+- **0.9.1 - June 02, 2016**
   - Add many new methods
   - Switch to opt-in monkey patching
-- **April.30.2016**: 0.9.0
+- **0.9.0 - April 30, 2016**
   - Gem Initial Release

data/README.md

@@ -21,15 +21,19 @@ Run `rails g rearmed:setup` to create a settings files in `config/initializers/r
 Rearmed.enabled_patches = {
   rails_4: {
     or: false,
-    link_to_confirm: false,
-    find_relation_each: false,
-    find_in_relation_batches: false,
+    link_to_confirm: false
   },
   rails_3: {
     hash_compact: false,
     pluck: false,
     update_columns: false,
-    all: false,
+    all: false
+  },
+  rails: {
+    pluck_to_hash: false,
+    pluck_to_struct: false,
+    find_relation_each: false,
+    find_in_relation_batches: false,
   },
   string: {
     to_bool: false,
@@ -127,6 +131,14 @@ hash.only!(:foo, :bar)
 
 ### Rails
 
+##### Additional ActiveRecord Methods
+```ruby
+Post.all.pluck_to_hash(:name, :category, :id)
+Post.all.pluck_to_struct(:name, :category, :id)
+Post.find_in_relation_batches # this returns a relation instead of an array
+Post.find_relation_each # this returns a relation instead of an array
+```
+
 ##### Rails 3.x Backports
 ```ruby
 my_hash.compact
@@ -137,12 +149,10 @@ Post.pluck(:name, :id) # adds multi column pluck support ex. => [['first', 1], [
 ```
 
 
-##### Rails 4.x Backports & Additional Methods
+##### Rails 4.x Backports
 ```ruby
 Post.where(name: 'foo').or.where(content: 'bar')
 = link_to 'Delete', post_path(post), method: :delete, confirm: "Are you sure you want to delete this post?" #returns rails 3 behaviour of allowing confirm attribute as well as data-confirm
-Post.find_in_relation_batches # this returns a relation instead of an array
-Post.find_relation_each # this returns a relation instead of an array
 ```
 
 # Credits

data/lib/generators/rearmed/setup_generator.rb

@@ -4,11 +4,9 @@ module Rearmed
   class SetupGenerator < Rails::Generators::Base
 
     def setup
-      contents = <<eos
+      create_file "config/initializers/rearmed.rb", <<eos
 Rearmed.enabled_patches = {
   rails_4: {
-    find_relation_each: false,
-    find_in_relation_batches: false,
     or: false,
     link_to_confirm: false
   },
@@ -18,6 +16,12 @@ Rearmed.enabled_patches = {
     update_columns: false,
     all: false
   },
+  rails: {
+    pluck_to_hash: false,
+    pluck_to_struct: false,
+    find_relation_each: false,
+    find_in_relation_batches: false,
+  },
   string: {
     to_bool: false,
     valid_integer: false,
@@ -28,8 +32,6 @@ Rearmed.enabled_patches = {
     dig: false
   },
   array: {
-    index_all: false,
-    find: false,
     dig: false,
     delete_first: false
   },
@@ -48,8 +50,6 @@ Rearmed.enabled_patches = {
 
 require 'rearmed/apply_patches'
 eos
-
-      create_file "config/initializers/rearmed.rb", contents
     end
 
   end

data/lib/rearmed/monkey_patches/rails.rb

@@ -0,0 +1,107 @@
+enabled = Rearmed.enabled_patches[:rails] == true
+
+if defined?(ActiveRecord)
+
+  if enabled || Rearmed.dig(Rearmed.enabled_patches, :rails, :pluck_to_hash) == true
+    ActiveRecord::Base.class_eval do
+      def self.pluck_to_hash(*keys)
+        hash_type = keys[-1].is_a?(Hash) ? keys.pop.fetch(:hash_type, HashWithIndifferentAccess) : HashWithIndifferentAccess
+        block_given = block_given?
+        keys, formatted_keys = format_keys(keys)
+        keys_one = keys.size == 1
+
+        pluck(*keys).map do |row|
+          value = hash_type[formatted_keys.zip(keys_one ? [row] : row)]
+          block_given ? yield(value) : value
+        end
+      end
+
+      def self.pluck_to_struct(*keys)
+        struct_type = keys[-1].is_a?(Hash) ? keys.pop.fetch(:struct_type, Struct) : Struct
+        block_given = block_given?
+        keys, formatted_keys = format_keys(keys)
+        keys_one = keys.size == 1
+
+        struct = struct_type.new(*formatted_keys)
+        pluck(*keys).map do |row|
+          value = keys_one ? struct.new(*[row]) : struct.new(*row)
+          block_given ? yield(value) : value
+        end
+      end
+
+      private
+
+      def self.format_keys(keys)
+        if keys.blank?
+          [column_names, column_names]
+        else
+          [
+            keys,
+            keys.map do |k|
+              case k
+              when String
+                k.split(/\bas\b/i)[-1].strip.to_sym
+              when Symbol
+                k
+              end
+            end
+          ]
+        end
+      end
+    end
+  end
+
+  ActiveRecord::Batches.module_eval do
+    if enabled || Rearmed.dig(Rearmed.enabled_patches, :rails, :find_in_relation_batches) == true
+      def find_in_relation_batches(options = {})
+        options.assert_valid_keys(:start, :batch_size)
+
+        relation = self
+        start = options[:start]
+        batch_size = options[:batch_size] || 1000
+
+        unless block_given?
+          return to_enum(:find_in_relation_batches, options) do
+            total = start ? where(table[primary_key].gteq(start)).size : size
+            (total - 1).div(batch_size) + 1
+          end
+        end
+
+        if logger && (arel.orders.present? || arel.taken.present?)
+          logger.warn("Scoped order and limit are ignored, it's forced to be batch order and batch size")
+        end
+
+        relation = relation.reorder(batch_order).limit(batch_size)
+        #records = start ? relation.where(table[primary_key].gteq(start)).to_a : relation.to_a
+        records = start ? relation.where(table[primary_key].gteq(start)) : relation
+
+        while records.any?
+          records_size = records.size
+          primary_key_offset = records.last.id
+          raise "Primary key not included in the custom select clause" unless primary_key_offset
+
+          yield records
+
+          break if records_size < batch_size
+
+          records = relation.where(table[primary_key].gt(primary_key_offset))#.to_a
+        end
+      end
+    end
+
+    if enabled || Rearmed.dig(Rearmed.enabled_patches, :rails, :find_relation_each) == true
+      def find_relation_each(options = {})
+        if block_given?
+          find_in_relation_batches(options) do |records|
+            records.each { |record| yield record }
+          end
+        else
+          enum_for :find_relation_each, options do
+            options[:start] ? where(table[primary_key].gteq(options[:start])).size : size
+          end
+        end
+      end
+    end
+  end
+
+end

data/lib/rearmed/monkey_patches/rails_3.rb

@@ -1,7 +1,7 @@
-rails_3_enabled = Rearmed.enabled_patches[:rails_3] == true
+enabled = Rearmed.enabled_patches[:rails_3] == true
 
 if defined?(ActiveSupport) && ActiveSupport::VERSION::MAJOR < 4
-  if rails_3_enabled || Rearmed.dig(Rearmed.enabled_patches, :rails_3, :hash_compact) == true
+  if enabled || Rearmed.dig(Rearmed.enabled_patches, :rails_3, :hash_compact) == true
     Hash.class_eval do
       def compact
         self.select{|_, value| !value.nil?}
@@ -16,7 +16,7 @@ end
 
 if defined?(ActiveRecord) && ActiveRecord::VERSION::MAJOR < 4
 
-  if rails_3_enabled || Rearmed.dig(Rearmed.enabled_patches, :rails_3, :all) == true
+  if enabled || Rearmed.dig(Rearmed.enabled_patches, :rails_3, :all) == true
     ActiveRecord::FinderMethods.module_eval do
       def all(*args)
         args.any? ? apply_finder_options(args.first) : self
@@ -24,7 +24,7 @@ if defined?(ActiveRecord) && ActiveRecord::VERSION::MAJOR < 4
     end
   end
 
-  if rails_3_enabled || Rearmed.dig(Rearmed.enabled_patches, :rails_3, :update_columns) == true
+  if enabled || Rearmed.dig(Rearmed.enabled_patches, :rails_3, :update_columns) == true
     ActiveRecord::Persistence::ClassMethods.module_eval do
       def update_columns(attributes)
         raise ActiveRecordError, "cannot update a new record" if new_record?
@@ -45,7 +45,7 @@ if defined?(ActiveRecord) && ActiveRecord::VERSION::MAJOR < 4
     end
   end
 
-  if rails_3_enabled || Rearmed.dig(Rearmed.enabled_patches, :rails_3, :pluck) == true
+  if enabled || Rearmed.dig(Rearmed.enabled_patches, :rails_3, :pluck) == true
     ActiveRecord::Relation.class_eval do
       def pluck(*args)
         args.map! do |column_name|

data/lib/rearmed/version.rb

@@ -1,3 +1,3 @@
 module Rearmed
-  VERSION = "1.0.0"
+  VERSION = "1.0.1"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rearmed
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.0.1
 platform: ruby
 authors:
 - Weston Ganger
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-06-08 00:00:00.000000000 Z
+date: 2016-06-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
@@ -71,12 +71,13 @@ files:
 - lib/rearmed/monkey_patches/enumerable.rb
 - lib/rearmed/monkey_patches/hash.rb
 - lib/rearmed/monkey_patches/object.rb
+- lib/rearmed/monkey_patches/rails.rb
 - lib/rearmed/monkey_patches/rails_3.rb
 - lib/rearmed/monkey_patches/rails_4.rb
 - lib/rearmed/monkey_patches/string.rb
 - lib/rearmed/version.rb
 - test/tc_rearmed.rb
-homepage: https://github.com/westonganger/rearmed_rb
+homepage: https://github.com/westonganger/rearmed-rb
 licenses: []
 metadata: {}
 post_install_message: