darthjee-active_ext 1.2.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 61c0f7192c30180cba2bd3c6a85d3892ab46ea98
+  data.tar.gz: 6e51dd5b85691b1b13e9b68e419c1bb1f4e95ec3
+SHA512:
+  metadata.gz: 68baae3ba89d2b91ae486248095572c457da021080e0715250aefd101f787f3dba620754f1443048eb2a3d239779c17ec0943294a96b85c8e08415a85bb5d416
+  data.tar.gz: e1d096d8f57e84c555849fbb36cc566534c81de6ef006f72251df6511840cb0628efe1d717d0c903718754254493715bc218023077178a741265e035491090da

data/.gitignore

@@ -0,0 +1 @@
+coverage

data/.rspec

@@ -0,0 +1 @@
+--color

data/Gemfile

@@ -0,0 +1,5 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in credential_builder.gemspec
+gemspec
+

data/Gemfile.lock

@@ -0,0 +1,64 @@
+PATH
+  remote: .
+  specs:
+    darthjee-active_ext (1.2.0)
+      activesupport (~> 5.1.1)
+      darthjee-core_ext (~> 1.2.6)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    activemodel (5.1.1)
+      activesupport (= 5.1.1)
+    activerecord (5.1.1)
+      activemodel (= 5.1.1)
+      activesupport (= 5.1.1)
+      arel (~> 8.0)
+    activesupport (5.1.1)
+      concurrent-ruby (~> 1.0, >= 1.0.2)
+      i18n (~> 0.7)
+      minitest (~> 5.1)
+      tzinfo (~> 1.1)
+    arel (8.0.0)
+    concurrent-ruby (1.0.5)
+    darthjee-core_ext (1.2.6)
+      activesupport (~> 5.1.1)
+    diff-lcs (1.2.5)
+    docile (1.1.5)
+    i18n (0.8.4)
+    json (2.1.0)
+    minitest (5.10.2)
+    rake (11.3.0)
+    rspec (2.99.0)
+      rspec-core (~> 2.99.0)
+      rspec-expectations (~> 2.99.0)
+      rspec-mocks (~> 2.99.0)
+    rspec-core (2.99.2)
+    rspec-expectations (2.99.2)
+      diff-lcs (>= 1.1.3, < 2.0)
+    rspec-mocks (2.99.4)
+    simplecov (0.14.1)
+      docile (~> 1.1.0)
+      json (>= 1.8, < 3)
+      simplecov-html (~> 0.10.0)
+    simplecov-html (0.10.1)
+    sqlite3 (1.3.10)
+    thread_safe (0.3.6)
+    tzinfo (1.2.3)
+      thread_safe (~> 0.1)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  activerecord (~> 5.1.1)
+  bundler (~> 1.6)
+  darthjee-active_ext!
+  rake (~> 11.3.0)
+  rspec (~> 2.14)
+  rspec-mocks (~> 2.99.4)
+  simplecov (~> 0.14.1)
+  sqlite3
+
+BUNDLED WITH
+   1.15.1

data/LICENSE

@@ -0,0 +1,22 @@
+The MIT License (MIT)
+
+Copyright (c) 2015 Bidu.com.br
+
+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,94 @@
+Active_Ext
+==========
+
+[![Code Climate](https://codeclimate.com/github/darthjee/active_ext/badges/gpa.svg)](https://codeclimate.com/github/darthjee/active_ext)
+[![Test Coverage](https://codeclimate.com/github/darthjee/active_ext/badges/coverage.svg)](https://codeclimate.com/github/darthjee/active_ext/coverage)
+[![Issue Count](https://codeclimate.com/github/darthjee/active_ext/badges/issue_count.svg)](https://codeclimate.com/github/darthjee/active_ext)
+
+# Usage
+This project adds some new methods to the core active_record classes
+
+To use active-ext either intall directly
+
+```console
+gem install darthjee-active_ext
+```
+
+or add it to Gemfile
+
+```
+gem 'darthjee-active_ext'
+```
+
+```console
+bundle install darthjee-active_ext
+```
+
+# methods added
+
+## ActiveRecord::Relation
+
+```ruby
+ActiveRecord::Schema.define do
+  self.verbose = false
+  
+  create_table :documents, :force => true do |t|
+    t.string :status
+    t.boolean :active, default: false
+    t.timestamps null: true
+  end
+end
+
+
+class Document < ActiveRecord::Base
+  scope :with_error, -> { where(status: :error) }
+  scope :with_success, -> { where(status: :success) }
+  scope :active, -> { where(active: true) }
+end
+
+2.times { Document.with_error.create }
+Document.active.with_error.create
+Document.active.with_success.create
+```
+
+### #percentage
+Returns the percentage of objects of a certain scope within another scope
+
+```ruby
+Document.percentage(:with_error)
+0.75
+```
+
+```ruby
+Document.percentage(status: :error)
+0.75
+```
+
+```ruby
+Document.percentage("status = 'error'")
+0.75
+```
+Works also when using nested scopes
+
+```ruby
+Document.active.percentage(:with_error)
+0.5
+```
+
+### #pluck_as_json
+Just as pluck returns some specifc columns, pluck_as_json returns the same coluns with keys to identify
+
+```ruby
+Document.pluck(:id, :active)
+[[1, true], [2, true]]
+```
+
+```ruby
+Document.pluck_as_json(:id, :active)
+[
+  {id: 18, active: false},
+  {id: 19, active: false},
+  {id: 20, active: true},
+  {id: 21, active: true}
+]
+```

data/Rakefile

@@ -0,0 +1,7 @@
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new
+
+task default: :spec
+task test: :spec

data/active_ext.gemspec

@@ -0,0 +1,29 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'darthjee/active_ext/version'
+
+Gem::Specification.new do |spec|
+  spec.name = 'darthjee-active_ext'
+  spec.version = Darthjee::ActiveExt::VERSION
+  spec.authors = ['Darthjee']
+  spec.email = ['darthjee@gmail.com']
+  spec.summary = 'Active Extensions'
+
+  spec.files = `git ls-files -z`.split("\x0")
+  spec.executables = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ['lib']
+
+  spec.add_runtime_dependency 'activesupport', '~> 5.1.1'
+  spec.add_runtime_dependency 'darthjee-core_ext', '~> 1.2.6'
+
+  spec.add_development_dependency 'activerecord', '~> 5.1.1'
+  spec.add_development_dependency 'sqlite3'
+
+  spec.add_development_dependency 'bundler', '~> 1.6'
+  spec.add_development_dependency 'rake', '~> 11.3.0'
+  spec.add_development_dependency 'rspec', '~> 2.14'
+  spec.add_development_dependency 'rspec-mocks', '~> 2.99.4'
+  spec.add_development_dependency 'simplecov', '~> 0.14.1'
+end

data/circle.yml

@@ -0,0 +1,16 @@
+dependencies:
+  post:
+    - curl -L https://codeclimate.com/downloads/test-reporter/test-reporter-latest-linux-amd64 > ./cc-test-reporter
+    - chmod +x ./cc-test-reporter
+
+
+database:
+  override:
+    - echo "Skipping DB section."
+
+test:
+  pre:
+    - bundle install
+    - ./cc-test-reporter before-build
+  override:
+    - bundle exec rspec; ./cc-test-reporter after-build --exit-code $?

data/lib/active_record/base_ext.rb

@@ -0,0 +1,10 @@
+require 'active_record'
+
+module ActiveRecord
+  class Base
+    class << self
+      delegate :percentage, :pluck_as_json, to: :all
+    end
+  end
+end
+

data/lib/active_record/relation_ext.rb

@@ -0,0 +1,23 @@
+require 'active_record'
+
+module ActiveRecord
+  class Relation
+    def percentage(*filters)
+      return 0 if count == 0
+
+      if filters.first.is_a?(Symbol)
+        filtered = filters.inject(self) do |relation, scope|
+          relation.public_send(scope)
+        end
+      else
+        filtered = where(*filters)
+      end
+
+      filtered.count * 1.0 / count
+    end
+
+    def pluck_as_json(*keys)
+      keys.empty? ? map(&:as_json) : pluck(*keys).map { |i| i.as_hash(keys) }
+    end
+  end
+end

data/lib/darthjee.rb

@@ -0,0 +1,4 @@
+module Darthjee
+  require 'darthjee/active_ext'
+end
+

data/lib/darthjee/active_ext.rb

@@ -0,0 +1,9 @@
+require 'darthjee/core_ext'
+require 'active_record/relation_ext'
+require 'active_record/base_ext'
+
+module Darthjee
+  module ActiveExt
+    require 'darthjee/active_ext/version'
+  end
+end

data/lib/darthjee/active_ext/version.rb

@@ -0,0 +1,5 @@
+module Darthjee
+  module ActiveExt
+    VERSION = '1.2.0'
+  end
+end

data/spec/lib/active_record/base_spec.rb

@@ -0,0 +1,13 @@
+require 'spec_helper'
+
+describe ActiveRecord::Relation do
+  let(:subject) { Document }
+
+  describe '.percentage' do
+    it_behaves_like 'a method that returns the percentage of objects found'
+  end
+
+  describe '.pluck_as_json' do
+    it_behaves_like 'a method that works as pluck but returning the keys'
+  end
+end

data/spec/lib/active_record/relation_spec.rb

@@ -0,0 +1,13 @@
+require 'spec_helper'
+
+describe ActiveRecord::Relation do
+  let(:subject) { Document.all }
+
+  describe '#percentage' do
+    it_behaves_like 'a method that returns the percentage of objects found'
+  end
+
+  describe '#pluck_as_json' do
+    it_behaves_like 'a method that works as pluck but returning the keys'
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,36 @@
+require 'simplecov'
+
+SimpleCov.profiles.define 'gem' do
+  add_filter '/spec/'
+end
+
+SimpleCov.start 'gem'
+require 'darthjee/active_ext'
+ActiveRecord::Base.establish_connection(adapter: "sqlite3", database: ":memory:")
+
+# This file was generated by the `rspec --init` command. Conventionally, all
+# specs live under a `spec` directory, which RSpec adds to the `$LOAD_PATH`.
+# Require this file using `require "spec_helper"` to ensure that it is only
+# loaded once.
+#
+# See http://rubydoc.info/gems/rspec-core/RSpec/Core/Configuration
+
+# Requires supporting ruby files with custom matchers and macros, etc,
+# in spec/support/ and its subdirectories.
+support_files = File.expand_path("spec/support/**/*.rb")
+Dir[support_files].each { |file| require file  }
+
+RSpec.configure do |config|
+  config.treat_symbols_as_metadata_keys_with_true_values = true
+  config.run_all_when_everything_filtered = true
+  config.filter_run :focus
+
+  # Run specs in random order to surface order dependencies. If you find an
+  # order dependency and want to debug it, you can fix the order by providing
+  # the seed, which is printed after each run.
+  # --seed 1234
+  config.order = 'random'
+
+  config.before do
+  end
+end

data/spec/support/models/document.rb

@@ -0,0 +1,5 @@
+class Document < ActiveRecord::Base
+  scope :with_error, -> { where(status: :error) }
+  scope :with_success, -> { where(status: :success) }
+  scope :active, -> { where(active: true) }
+end

data/spec/support/schema.rb

@@ -0,0 +1,9 @@
+ActiveRecord::Schema.define do
+  self.verbose = false
+
+  create_table :documents, :force => true do |t|
+    t.string :status
+    t.boolean :active, default: false
+    t.timestamps null: true
+  end
+end

data/spec/support/shared_examples/active_relation.rb

@@ -0,0 +1,79 @@
+require 'spec_helper'
+
+shared_examples 'a method that returns the percentage of objects found' do
+  let(:error_number) { 1 }
+  let(:success_number) { 1 }
+  let(:active_error_number) { 0 }
+  let(:active_success_number) { 0 }
+
+  before do
+    Document.delete_all
+    error_number.times { Document.create(status: :error) }
+    success_number.times { Document.create(status: :success) }
+    active_error_number.times { Document.active.create(status: :error) }
+    active_success_number.times { Document.active.create(status: :success) }
+  end
+
+  context 'when there are 50% documents with error' do
+    it do
+      expect(subject.percentage(status: :error)).to eq(0.5)
+    end
+  end
+
+  context 'when there are 25% documents with error' do
+    let(:success_number) { 3 }
+
+    it do
+      expect(subject.percentage(status: :error)).to eq(0.25)
+    end
+  end
+
+  context 'when passing a sub scope' do
+    let(:active_error_number) { 1 }
+    let(:active_success_number) { 4 }
+
+    it 'does the math inside the scope' do
+      expect(Document.active.percentage(:with_error)).to eq(0.2)
+    end
+  end
+
+  context 'when passing a string with SQL query' do
+    it 'returns the correct percentage' do
+      expect(subject.percentage("status ='error'")).to eq(0.5)
+    end
+  end
+
+  context 'when passing a scope name instead of query' do
+    it 'returns the correct percentage' do
+      expect(subject.percentage(:with_error)).to eq(0.5)
+    end
+  end
+end
+
+shared_examples 'a method that works as pluck but returning the keys' do
+  let(:json) { subject.pluck_as_json(:id, :status) }
+  let(:expected) do
+    [ { id: 1, status: 'error' }, { id: 2, status: 'success' } ]
+  end
+
+  before do
+    Document.delete_all
+    Document.create(id: 1, status: :error)
+    Document.create(id: 2, status: :success)
+  end
+
+  it 'returns an array of hashes' do
+    expect(json).to eq(expected)
+  end
+
+  context 'when no arguments are given' do
+    let(:keys) do
+      subject.pluck_as_json.first.keys
+    end
+    let(:expected) {%w(id status updated_at created_at active)}
+
+    it 'returns all keys' do
+      expect(keys).to match_array(expected)
+    end
+  end
+end

metadata

@@ -0,0 +1,195 @@
+--- !ruby/object:Gem::Specification
+name: darthjee-active_ext
+version: !ruby/object:Gem::Version
+  version: 1.2.0
+platform: ruby
+authors:
+- Darthjee
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2017-06-21 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 5.1.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 5.1.1
+- !ruby/object:Gem::Dependency
+  name: darthjee-core_ext
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.2.6
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.2.6
+- !ruby/object:Gem::Dependency
+  name: activerecord
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 5.1.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 5.1.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'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 11.3.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 11.3.0
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.14'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.14'
+- !ruby/object:Gem::Dependency
+  name: rspec-mocks
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.99.4
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.99.4
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.14.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.14.1
+description: 
+email:
+- darthjee@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- Gemfile
+- Gemfile.lock
+- LICENSE
+- README.md
+- Rakefile
+- active_ext.gemspec
+- circle.yml
+- lib/active_record/base_ext.rb
+- lib/active_record/relation_ext.rb
+- lib/darthjee.rb
+- lib/darthjee/active_ext.rb
+- lib/darthjee/active_ext/version.rb
+- spec/lib/active_record/base_spec.rb
+- spec/lib/active_record/relation_spec.rb
+- spec/spec_helper.rb
+- spec/support/models/document.rb
+- spec/support/schema.rb
+- spec/support/shared_examples/active_relation.rb
+homepage: 
+licenses: []
+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.6.8
+signing_key: 
+specification_version: 4
+summary: Active Extensions
+test_files:
+- spec/lib/active_record/base_spec.rb
+- spec/lib/active_record/relation_spec.rb
+- spec/spec_helper.rb
+- spec/support/models/document.rb
+- spec/support/schema.rb
+- spec/support/shared_examples/active_relation.rb