hello_code_active_record_utils 0.2.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 6f0f3fd33a559a96b97434f86b16faafa95eecb8
+  data.tar.gz: c3919fe1cbd95bbce6a23d669fc80977db585c2e
+SHA512:
+  metadata.gz: f0d1945f8465710cc82a76d7567699a39e36bbf11ac9269af54c0f98bea1ffcbc95feced4303aa620ae93f0f4598991afd2bd6060b3da1bb49dbb83a4502d2ec
+  data.tar.gz: 8e3ed0200b7a7c4ac3e18e838f5ff291e9c1d12ec8adf9a07be35cdd1ebfbe180c843b696250699444a744c0a04b25e5f11a1439f8cfb8a37e84b3b7b1429292

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2015 
+
+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.rdoc

@@ -0,0 +1,3 @@
+= HelloCodeActiveRecordUtils
+
+This project rocks and uses MIT-LICENSE.

data/Rakefile

@@ -0,0 +1,19 @@
+begin
+  require 'bundler/setup'
+rescue LoadError
+  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+end
+
+require 'rdoc/task'
+
+RDoc::Task.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'HelloCodeActiveRecordUtils'
+  rdoc.options << '--line-numbers'
+  rdoc.rdoc_files.include('README.rdoc')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+load 'rails/tasks/statistics.rake'
+
+Bundler::GemHelper.install_tasks

data/lib/hello_code/active_record_utils.rb

@@ -0,0 +1,9 @@
+module HelloCode
+  module ActiveRecordUtils
+  end
+end
+
+require 'hello_code/active_record_utils/engine'
+require 'hello_code/active_record_utils/version'
+require 'hello_code/active_record_utils/concerns'
+require 'hello_code/active_record_utils/loader'

data/lib/hello_code/active_record_utils/concerns.rb

@@ -0,0 +1,13 @@
+module HelloCode
+  module ActiveRecordUtils
+    module Concerns
+      extend ActiveSupport::Autoload
+
+      autoload :Deletable,          'hello_code/active_record_utils/concerns/deletable'
+      autoload :Filterable,         'hello_code/active_record_utils/concerns/filterable'
+      autoload :Paginable,          'hello_code/active_record_utils/concerns/paginable'
+      autoload :Sluggable,          'hello_code/active_record_utils/concerns/sluggable'
+      autoload :RelationshipScopes, 'hello_code/active_record_utils/concerns/relationship_scopes'
+    end
+  end
+end

data/lib/hello_code/active_record_utils/concerns/deletable.rb

@@ -0,0 +1,20 @@
+module HelloCode
+  module ActiveRecordUtils
+    module Concerns
+      module Deletable
+        extend ActiveSupport::Concern
+
+        included do
+          default_scope { where(deleted_at: nil) }
+
+          scope :including_deleted, -> { unscope(where: :deleted_at) }
+        end
+
+        def delete!
+          self.deleted_at = Time.current
+          self
+        end
+      end
+    end
+  end
+end

data/lib/hello_code/active_record_utils/concerns/filterable.rb

@@ -0,0 +1,33 @@
+module HelloCode
+  module ActiveRecordUtils
+    module Concerns
+      module Filterable
+        extend ActiveSupport::Concern
+
+        included do
+          scope :filtered, lambda { |values|
+            current = all
+            filters.each do |key, method|
+              if values.try(:key?, key)
+                current = current.send(method, values[key]) if
+                  current.respond_to?(method)
+              end
+            end
+            current
+          }
+        end
+
+        module ClassMethods
+          def add_filter(filter_key, method_name, callable = nil)
+            scope(method_name, callable) if callable
+            filters[filter_key] = method_name
+          end
+
+          def filters
+            @filters ||= {}
+          end
+        end
+      end
+    end
+  end
+end

data/lib/hello_code/active_record_utils/concerns/paginable.rb

@@ -0,0 +1,58 @@
+module HelloCode
+  module ActiveRecordUtils
+    module Concerns
+      module Paginable
+        extend ActiveSupport::Concern
+
+        included do
+          # Default items per page
+          items_per_page 25
+
+          scope :paginate, lambda { |page, items_per_page = @items_per_page|
+            limit(items_per_page)
+              .offset(([page.to_i, 1].max - 1) * items_per_page)
+              .extending do
+
+              def current_page
+                @current_page ||=
+                  if total_pages.zero?
+                    0
+                  else
+                    (offset_value / limit_value.to_f).ceil + 1
+                  end
+              end
+
+              # If pagination is used this
+              def total_items
+                @total_items ||=
+                  begin
+                    total_rows = except(:offset, :limit, :order)
+                    total_rows = total_rows.except(:includes) if eager_loading?
+                    total_rows.distinct(:id).count
+                  end
+              end
+
+              def total_pages
+                @total_pages ||=
+                  begin
+                    (total_items / limit_value.to_f).ceil
+                  end
+              end
+            end
+          }
+        end
+
+        module ClassMethods
+          def items_per_page(items)
+            @items_per_page = items
+          end
+
+          def pages
+            (all.except(:offset, :limit, :order, :includes)
+              .distinct(:id).count / @items_per_page.to_f).ceil
+          end
+        end
+      end
+    end
+  end
+end

data/lib/hello_code/active_record_utils/concerns/relationship_scopes.rb

@@ -0,0 +1,27 @@
+module HelloCode
+  module ActiveRecordUtils
+    module Concerns
+      module RelationshipScopes
+        extend ActiveSupport::Concern
+
+        module ClassMethods
+          def relationship_scopes(relationship, suffix = nil)
+            suffix ||= relationship
+
+            with_scope_name    = "with_#{ suffix }".to_sym
+            include_scope_name = "include_#{ suffix }".to_sym
+            and_scope_name     = "and_#{ suffix }".to_sym
+
+            scope with_scope_name,    -> { joins(relationship) }
+            scope include_scope_name, -> { includes(relationship) }
+            scope and_scope_name,     -> { joins(relationship) }
+
+            scope load_scope_name,    -> { preload(relationship) }
+
+            nil
+          end
+        end
+      end
+    end
+  end
+end

data/lib/hello_code/active_record_utils/concerns/sluggable.rb

@@ -0,0 +1,62 @@
+module HelloCode
+  module ActiveRecordUtils
+    module Concerns
+      module Sluggable
+        extend ActiveSupport::Concern
+
+        included do
+          # Be sure to create a valid slug before validating and saving.
+          before_validation :set_slug, on: [:create, :update]
+          after_validation :delete_slug_errors
+
+          # Scope to query by slug
+          scope :by_slug, ->(slug) { where(slug: slug) }
+
+          # Slug must be present
+          validates :slug, presence: true, length: { maximum: 256 }
+        end
+
+        module ClassMethods
+          # Find by slug
+          def find_by_slug(slug)
+            by_slug(slug).take
+          end
+        end
+
+        def to_param
+          slug
+        end
+
+        private
+
+        def set_slug
+          self.slug = qualify_slug(name.parameterize) if
+            name.present? && slug.blank?
+        end
+
+        def delete_slug_errors
+          errors.delete(:slug)
+        end
+
+        def qualify_slug(base_slug)
+          tentative_slug = base_slug
+          while duplicate_slug?(tentative_slug)
+            tentative_slug = generate_slug_name(base_slug)
+          end
+          tentative_slug
+        end
+
+        def duplicate_slug?(slug)
+          self.class
+            .where.not(id: id)
+            .by_slug(slug)
+            .exists?
+        end
+
+        def generate_slug_name(slug)
+          "#{slug}-#{SecureRandom.random_number(10_000)}"
+        end
+      end
+    end
+  end
+end

data/lib/hello_code/active_record_utils/engine.rb

@@ -0,0 +1,7 @@
+module HelloCode
+  module ActiveRecordUtils
+    class Engine < ::Rails::Engine
+      isolate_namespace HelloCode
+    end
+  end
+end

data/lib/hello_code/active_record_utils/loader.rb

@@ -0,0 +1,21 @@
+module HelloCode
+  module ActiveRecordUtil
+    module Loader
+      extend ActiveSupport::Concern
+
+      module ClassMethods
+        def utility! (*modules)
+          modules = modules.is_a?(Array) ? modules : [ modules ]
+
+          modules.each.map{|i| i.to_s.camelize }.each do |mod|
+            include HelloCode::ActiveRecordUtils::Concerns.const_get(mod)
+          end
+
+          nil
+        end
+      end
+
+      ActiveRecord::Base.send(:include, self)
+    end
+  end
+end

data/lib/hello_code/active_record_utils/version.rb

@@ -0,0 +1,5 @@
+module HelloCode
+  module ActiveRecordUtils
+    VERSION = "0.2.0"
+  end
+end

data/lib/hello_code_active_record_utils.rb

@@ -0,0 +1 @@
+require "hello_code/active_record_utils"

data/lib/tasks/hello_code_active_record_utils_tasks.rake

@@ -0,0 +1,4 @@
+# desc "Explaining what the task does"
+# task :hello_code_active_record_utils do
+#   # Task goes here
+# end

metadata

@@ -0,0 +1,87 @@
+--- !ruby/object:Gem::Specification
+name: hello_code_active_record_utils
+version: !ruby/object:Gem::Version
+  version: 0.2.0
+platform: ruby
+authors:
+- Francisco Soto
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-04-16 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 4.2.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 4.2.1
+- !ruby/object:Gem::Dependency
+  name: sqlite3
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: ''
+email:
+- bobby@hellocode.mx
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- MIT-LICENSE
+- README.rdoc
+- Rakefile
+- lib/hello_code/active_record_utils.rb
+- lib/hello_code/active_record_utils/concerns.rb
+- lib/hello_code/active_record_utils/concerns/deletable.rb
+- lib/hello_code/active_record_utils/concerns/filterable.rb
+- lib/hello_code/active_record_utils/concerns/paginable.rb
+- lib/hello_code/active_record_utils/concerns/relationship_scopes.rb
+- lib/hello_code/active_record_utils/concerns/sluggable.rb
+- lib/hello_code/active_record_utils/engine.rb
+- lib/hello_code/active_record_utils/loader.rb
+- lib/hello_code/active_record_utils/version.rb
+- lib/hello_code_active_record_utils.rb
+- lib/tasks/hello_code_active_record_utils_tasks.rake
+homepage: https://github.com/HelloCodeMX/active_record_utils
+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.4.5
+signing_key: 
+specification_version: 4
+summary: ActiveRecord extensions to make life easier.
+test_files: []