pluck_global_id 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 72cada23bff291533081e6643c2f54d9e6d4ba58
+  data.tar.gz: 115f480b4603b6ebd77d61b6c7c4985e36512def
+SHA512:
+  metadata.gz: 59a307dd49229af8a95896efb5bb3cc060b2e104daa95679f6b25629c2455ebc59fc71ee8fc36e952bfe0f22e39f8b8e2ca96d486939fde0f4ef3f0168091ad4
+  data.tar.gz: d02395478789cca654c5aa721d912608238a48bd7fcebed0b1922af792e83a8f256a121a6684fd545defc7171e166132dfaca92f7e69eaeee43a0492cd1f60cd

data/.gitignore

@@ -0,0 +1,14 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2015 Lukas Fittl
+
+MIT License
+
+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,42 @@
+# activerecord-pluck-globalid
+
+Helper method to easily get GlobalIDs from an ActiveRecord scope without instantiating AR objects.
+
+Useful for mass-creating ActiveJob jobs from a specific subset of your records.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'activerecord-pluck-globalid'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install activerecord-pluck-globalid
+
+## Usage
+
+Use ```pluck_globalid``` when you want to instantiate ActiveJob from a scope:
+
+```ruby
+user_gids = User.where(active: true).pluck_globalid
+user_gids.each do |user_gid|
+  UserWorker.perform_later(user_gid)
+end
+```
+
+This avoids costly AR objects which can consume significant memory in such cases.
+
+## Contributing
+
+1. Fork it ( https://github.com/lfittl/activerecord-pluck-globalid/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create a new Pull Request

data/Rakefile

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

data/lib/pluck_global_id.rb

@@ -0,0 +1,4 @@
+require 'pluck_global_id/version'
+require 'pluck_global_id/record'
+require 'pluck_global_id/relation_methods'
+require 'pluck_global_id/railtie' if defined?(Rails)

data/lib/pluck_global_id/railtie.rb

@@ -0,0 +1,13 @@
+require 'rails/railtie'
+
+module PluckGlobalID
+  class Railtie < Rails::Railtie
+    initializer 'pluck_global_id' do |app|
+      ActiveSupport.on_load :active_record do
+        ::ActiveRecord::Base.extend PluckGlobalID::RelationMethods
+        ::ActiveRecord::Relation.send(:include, PluckGlobalID::RelationMethods)
+        ::ActiveRecord::Associations::CollectionProxy.send(:include, PluckGlobalID::RelationMethods)
+      end
+    end
+  end
+end

data/lib/pluck_global_id/record.rb

@@ -0,0 +1,21 @@
+require 'globalid'
+
+module PluckGlobalID
+  class Record
+    # Necessary for ActiveJob to detect this as a serialize-able object
+    include ::GlobalID::Identification
+
+    def initialize(model_name, model_id, options = {})
+      app = options.fetch :app, GlobalID.app
+      @global_id = GlobalID.new URI("gid://#{app}/#{model_name}/#{model_id}")
+    end
+
+    def to_global_id
+      @global_id
+    end
+
+    def to_signed_global_id
+      fail ArgumentError, 'Not implemented'
+    end
+  end
+end

data/lib/pluck_global_id/relation_methods.rb

@@ -0,0 +1,9 @@
+module PluckGlobalID
+  module RelationMethods
+    def pluck_global_id(options = {})
+      pluck(:id).map do |id|
+        PluckGlobalID::Record.new self.name, id
+      end
+    end
+  end
+end

data/lib/pluck_global_id/version.rb

@@ -0,0 +1,3 @@
+module PluckGlobalID
+  VERSION = '0.0.1'
+end

data/pluck_global_id.gemspec

@@ -0,0 +1,30 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'pluck_global_id/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "pluck_global_id"
+  spec.version       = PluckGlobalID::VERSION
+  spec.authors       = ["Lukas Fittl"]
+  spec.email         = ["lukas@fittl.com"]
+  spec.summary       = %q{Get GlobalIDs from an ActiveRecord scope without instantiating AR objects}
+  spec.description   = ''
+  spec.homepage      = 'https://github.com/lfittl/pluck_global_id'
+  spec.license       = "MIT"
+
+  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 "activerecord", ">= 4.0"
+  spec.add_runtime_dependency "railties", ">= 4.0"
+  spec.add_runtime_dependency "globalid", "~> 0.3.0"
+
+  spec.add_development_dependency "bundler", "~> 1.7"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3"
+  spec.add_development_dependency "rspec-rails"
+  spec.add_development_dependency "sqlite3"
+end

data/spec/lib/pluck_globalid_spec.rb

@@ -0,0 +1,27 @@
+require 'spec_helper'
+
+RSpec.describe PluckGlobalID do
+  it 'returns GlobalID records' do
+    sample = Sample.create! name: 'Something'
+
+    gid_record = Sample.pluck_global_id.first
+    expect(gid_record).to be_present
+    expect(gid_record).to be_a(PluckGlobalID::Record)
+    expect(gid_record.to_global_id).to eq sample.to_global_id
+  end
+
+  it 'respects where clauses on the scope' do
+    s1 = Sample.create! name: 'sample 1'
+    s2 = Sample.create! name: 'sample 2'
+    expect(Sample.where(name: 'sample 1').pluck_global_id.map(&:to_global_id)).to eq [s1.to_global_id]
+  end
+
+  it 'works with limit' do
+    10.times { Sample.create! name: 'Something' }
+    expect(Sample.limit(1).pluck_global_id.size).to eq 1
+  end
+
+  it 'works with empty scopes' do
+    expect(Sample.pluck_global_id).to eq []
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,24 @@
+require 'bundler/setup'
+require 'rails/all'
+require 'pluck_global_id'
+
+class Sample < ActiveRecord::Base
+  include GlobalID::Identification
+end
+
+RSpec.configure do |config|
+  config.before(:suite) do
+    PluckGlobalID::Railtie.run_initializers
+    GlobalID.app = 'sample'
+
+    ActiveRecord::Base.establish_connection adapter: 'sqlite3', database: ':memory:'
+
+    ActiveRecord::Migration.create_table :samples do |t|
+      t.string :name
+    end
+  end
+
+  config.before(:each) do
+    Sample.delete_all
+  end
+end

metadata

@@ -0,0 +1,171 @@
+--- !ruby/object:Gem::Specification
+name: pluck_global_id
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Lukas Fittl
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-01-22 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activerecord
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '4.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '4.0'
+- !ruby/object:Gem::Dependency
+  name: railties
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '4.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '4.0'
+- !ruby/object:Gem::Dependency
+  name: globalid
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.3.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.3.0
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+- !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'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3'
+- !ruby/object:Gem::Dependency
+  name: rspec-rails
+  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: 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:
+- lukas@fittl.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/pluck_global_id.rb
+- lib/pluck_global_id/railtie.rb
+- lib/pluck_global_id/record.rb
+- lib/pluck_global_id/relation_methods.rb
+- lib/pluck_global_id/version.rb
+- pluck_global_id.gemspec
+- spec/lib/pluck_globalid_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/lfittl/pluck_global_id
+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: Get GlobalIDs from an ActiveRecord scope without instantiating AR objects
+test_files:
+- spec/lib/pluck_globalid_spec.rb
+- spec/spec_helper.rb