whitelist_scope 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 39d0bc2d121a69ebd370d5e3be7387980158b149
+  data.tar.gz: 0716602a749ed81bd644456388f3f039dddc5c4f
+SHA512:
+  metadata.gz: 66565417db336737fc0f3c47527f9c8d65d739bd60370d84bca2ab898bc7b7a1b03d33fe4dc7073ae4185aeff7b94dc1f208fee1d8b606cdeef0bb75d7b8faea
+  data.tar.gz: 64db06826460ad93677ac6d87780a73bec68c6a108b2371aa35aa30ab6bf3d6ee2e06dc561a8d9c660c9c14f4bde3962ca255089c7381ae872c55f32a0567e86

data/.gitignore

@@ -0,0 +1,13 @@
+.bundle/
+log/*.log
+pkg/
+spec/dummy/db/*.sqlite3
+spec/dummy/db/*.sqlite3-journal
+spec/dummy/log/*.log
+spec/dummy/tmp/
+spec/dummy/.sass-cache
+bin/
+.DS_Store
+gemfiles/*.lock
+coverage/
+coverage/**/*

data/.rspec

@@ -0,0 +1,3 @@
+--color
+--require spec_helper
+--format Fuubar

data/.travis.yml

@@ -0,0 +1,16 @@
+language: ruby
+script: bundle exec rspec
+rvm:
+  - 1.9.3
+  - 2.0.0
+  - 2.1.0
+  - 2.2.0
+gemfile:
+  - gemfiles/3.2.gemfile
+  - gemfiles/4.0.gemfile
+  - gemfiles/4.1.gemfile
+  - gemfiles/4.2.gemfile
+branches:
+  only:
+    - stable
+    - develop

data/Appraisals

@@ -0,0 +1,15 @@
+appraise "3.2" do
+  gem "rails", "~> 3.2.15"
+end
+
+appraise "4.0" do
+  gem "rails", "~> 4.0.0"
+end
+
+appraise "4.1" do
+  gem "rails", "~> 4.1.0"
+end
+
+appraise "4.2" do
+  gem "rails", "~> 4.2.0"
+end

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,35 @@
+#Code of Conduct
+
+Summary
+-------
+
+Harassment in code and discussion or violation of physical boundaries is completely unacceptable anywhere in WhitelistScope’s project codebases, issue trackers, chatrooms, mailing lists, meetups, etc. Violations will result in being warned, blocked or banned by the core team at or before the 3rd violation.
+
+In detail
+---------
+
+Harassment includes offensive verbal comments related to gender identity, gender expression, sexual orientation, disability, physical appearance, body size, race, ethnicity, nationality, religion, as well as sexual images, deliberate intimidation, stalking, sustained disruption, and unwelcome sexual attention.
+
+Individuals asked to stop any harassing behavior are expected to comply immediately.
+
+Maintainers, including members of the core team, are also subject to the anti-harassment policy.
+
+If anyone engages in harassing behavior, including maintainers, we may take appropriate action, up to and including warning the offender, deletion of comments, removal from the project’s codebase and communication systems, and escalation to GitHub support.
+
+If you are being harassed, notice that someone else is being harassed, or have any other concerns, please contact a member of the core team immediately.
+
+We expect everyone to follow these rules in any and all public spaces associated with the WhitelistScope project, including codebases, issue trackers, chatrooms, social media, and mailing lists. Additonally, we expect members of the core team to follow these rules on personal accounts where they are associated with the project, for instance in tweets or forums posts from an account where they identify themselves as a project maintainer.
+
+Finally, don't forget that it is human to make mistakes! We all do. Let’s work together to help each other, resolve issues, and learn from the mistakes that we will all inevitably make from time to time.
+
+Thanks
+------
+
+Thanks to the [Thoughtbot Code of Conduct](https://thoughtbot.com/open-source-code-of-conduct), [CocoaPods Code of Conduct](https://github.com/CocoaPods/CocoaPods/blob/master/CODE_OF_CONDUCT.md), [Bundler Code of Conduct](http://bundler.io/conduct.html), [JSConf Code of Conduct](http://jsconf.com/codeofconduct.html), and [Contributor Covenant](http://contributor-covenant.org/) for inspiration and ideas.
+
+License
+-------
+
+To the extent possible under law, WhitelistScope has waived all copyright and related or neighboring rights to the WhitelistScope Code of Conduct. This work is published from the United States.
+
+[![CC0](https://i.creativecommons.org/p/zero/1.0/88x31.png)](https://creativecommons.org/publicdomain/zero/1.0/)

data/Gemfile

@@ -0,0 +1,14 @@
+source 'https://rubygems.org'
+
+# Declare your gem's dependencies in whitelist_scope.gemspec.
+# Bundler will treat runtime dependencies like base dependencies, and
+# development dependencies will be added by default to the :development group.
+gemspec
+
+# Declare any dependencies that are still in development here instead of in
+# your gemspec. These might include edge Rails or gems from your path or
+# Git. Remember to move these dependencies to your gemspec before releasing
+# your gem to rubygems.org.
+
+# To use a debugger
+# gem 'byebug', group: [:development, :test]

data/Gemfile.lock

@@ -0,0 +1,97 @@
+PATH
+  remote: .
+  specs:
+    whitelist_scope (0.1.0)
+      activerecord (>= 3.2.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    activemodel (4.2.4)
+      activesupport (= 4.2.4)
+      builder (~> 3.1)
+    activerecord (4.2.4)
+      activemodel (= 4.2.4)
+      activesupport (= 4.2.4)
+      arel (~> 6.0)
+    activesupport (4.2.4)
+      i18n (~> 0.7)
+      json (~> 1.7, >= 1.7.7)
+      minitest (~> 5.1)
+      thread_safe (~> 0.3, >= 0.3.4)
+      tzinfo (~> 1.1)
+    appraisal (2.1.0)
+      bundler
+      rake
+      thor (>= 0.14.0)
+    arel (6.0.3)
+    builder (3.2.2)
+    coveralls (0.8.2)
+      json (~> 1.8)
+      rest-client (>= 1.6.8, < 2)
+      simplecov (~> 0.10.0)
+      term-ansicolor (~> 1.3)
+      thor (~> 0.19.1)
+    diff-lcs (1.2.5)
+    docile (1.1.5)
+    domain_name (0.5.24)
+      unf (>= 0.0.5, < 1.0.0)
+    fuubar (2.0.0)
+      rspec (~> 3.0)
+      ruby-progressbar (~> 1.4)
+    http-cookie (1.0.2)
+      domain_name (~> 0.5)
+    i18n (0.7.0)
+    json (1.8.3)
+    mime-types (2.6.2)
+    minitest (5.8.1)
+    netrc (0.10.3)
+    rake (10.4.2)
+    rest-client (1.8.0)
+      http-cookie (>= 1.0.2, < 2.0)
+      mime-types (>= 1.16, < 3.0)
+      netrc (~> 0.7)
+    rspec (3.3.0)
+      rspec-core (~> 3.3.0)
+      rspec-expectations (~> 3.3.0)
+      rspec-mocks (~> 3.3.0)
+    rspec-core (3.3.2)
+      rspec-support (~> 3.3.0)
+    rspec-expectations (3.3.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.3.0)
+    rspec-mocks (3.3.2)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.3.0)
+    rspec-support (3.3.0)
+    ruby-progressbar (1.7.5)
+    simplecov (0.10.0)
+      docile (~> 1.1.0)
+      json (~> 1.8)
+      simplecov-html (~> 0.10.0)
+    simplecov-html (0.10.0)
+    sqlite3 (1.3.10)
+    term-ansicolor (1.3.2)
+      tins (~> 1.0)
+    thor (0.19.1)
+    thread_safe (0.3.5)
+    tins (1.6.0)
+    tzinfo (1.2.2)
+      thread_safe (~> 0.1)
+    unf (0.1.4)
+      unf_ext
+    unf_ext (0.0.7.1)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  appraisal
+  coveralls
+  fuubar
+  rspec
+  sqlite3
+  whitelist_scope!
+
+BUNDLED WITH
+   1.10.6

data/LICENSE

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2015 Melody
+
+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,74 @@
+#Whitelist Scope
+
+[![Gem Version](https://badge.fury.io/rb/whitelist_scope.svg)](http://badge.fury.io/rb/whitelist_scope)[![Build Status](https://travis-ci.org/meltheadorable/whitelist_scope.svg)](https://travis-ci.org/meltheadorable/whitelist_scope)[![Code Climate](https://codeclimate.com/github/meltheadorable/whitelist_scope/badges/gpa.svg)](https://codeclimate.com/github/meltheadorable/whitelist_scope)[![Coverage Status](https://coveralls.io/repos/meltheadorable/whitelist_scope/badge.svg?branch=stable)](https://coveralls.io/r/meltheadorable/whitelist_scope?branch=stable)[![Dependency Status](https://gemnasium.com/meltheadorable/whitelist_scope.svg)](https://gemnasium.com/meltheadorable/whitelist_scope)[![Documentation Status](http://inch-ci.org/github/meltheadorable/whitelist_scope.svg?branch=develop)](http://inch-ci.org/github/meltheadorable/whitelist_scope)
+
+`whitelist_scope` provides a safe way to register and call scopes inside rails apps
+
+> #### :warning: **Warning**:
+>
+> whitelist_scope is in the very early stages of development right now, has few tests and could introduce breaking changes. Use at your own risk.
+
+Getting Started
+---------------
+
+To get started, add whitelist_scope to your gemfile:
+
+`gem 'whitelist_scope'`
+
+Then run `bundle install` to fetch the current version.
+
+Usage
+-----
+
+Using WhitelistScope is very simple. All you need to do is specify whitelisted scopes in your models, then call `call_whitelisted_scope` in your controllers naming a scope.
+
+### Models
+
+Whitelist Scope acts as a wrapper around ActiveRecord scopes, providing a tiny bit of extra functionality to keep track of the whitelist.
+
+If you don't know what scopes are, [you can read about them here](http://guides.rubyonrails.org/active_record_querying.html#scopes):
+
+First you'll need to extend WhitelistScope, and then you can specify your scopes.
+
+```ruby
+class Item < ActiveRecord::Base
+  extend WhitelistScope # includes the whitelist_scope methods in your model
+
+  whitelist_scope :most_recent, -> { order(updated_at: :desc) }
+  whitelist_scope :created_first, -> { order(created_at: :asc) }
+end
+```
+
+`whitelist_scope` takes a symbol as a name, and a lambda, exactly like an ActiveRecord scope.
+
+### Controllers
+
+For your controllers, WhitelistScope provides the `call_whitelisted_scope` method, which takes a string naming one of your whitelisted scopes as an argument. Because WhitelistScope uses scopes under the hood, it can be chained with other scopes.
+
+> #### :warning: **Warning**:
+>
+> The `whitelist_scope` method will raise a `NoMethodError` if it cannot find a whitelisted with the name you passed in.
+
+```ruby
+class ItemController < ApplicationController
+  def index
+    @items = Item.call_whitelisted_scope("most_recent") # sorts your items by most recent
+    @others = Item.call_whitelisted_scope(params[:sort]) # sorts by the method specified in the params
+  end
+end
+```
+
+Because it uses scopes under the hood, WhitelistScope also provides separate methods for your whitelisted scopes:
+
+```ruby
+class ItemController < ApplicationController
+  def index
+    @items = Item.created_first # all of your Items, sorted by creation date
+  end
+end
+```
+
+License
+-------
+
+WhitelistScope is released under the [MIT License](LICENSE)

data/Rakefile

@@ -0,0 +1,22 @@
+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    = 'Whitelist Scope'
+  rdoc.options << '--line-numbers'
+  rdoc.rdoc_files.include('README.md')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+
+
+
+
+
+Bundler::GemHelper.install_tasks

data/gemfiles/3.2.gemfile

@@ -0,0 +1,7 @@
+# This file was generated by Appraisal
+
+source "https://rubygems.org"
+
+gem "rails", "~> 3.2.15"
+
+gemspec :path => "../"

data/gemfiles/4.0.gemfile

@@ -0,0 +1,7 @@
+# This file was generated by Appraisal
+
+source "https://rubygems.org"
+
+gem "rails", "~> 4.0.0"
+
+gemspec :path => "../"

data/gemfiles/4.1.gemfile

@@ -0,0 +1,7 @@
+# This file was generated by Appraisal
+
+source "https://rubygems.org"
+
+gem "rails", "~> 4.1.0"
+
+gemspec :path => "../"

data/gemfiles/4.2.gemfile

@@ -0,0 +1,7 @@
+# This file was generated by Appraisal
+
+source "https://rubygems.org"
+
+gem "rails", "~> 4.2.0"
+
+gemspec :path => "../"

data/lib/whitelist_scope/version.rb

@@ -0,0 +1,3 @@
+module WhitelistScope
+  VERSION = "0.1.0"
+end

data/lib/whitelist_scope.rb

@@ -0,0 +1,27 @@
+require "whitelist_scope/version"
+
+module WhitelistScope
+  attr_reader :whitelist
+
+  def whitelist_scope(name, body)
+    @whitelist ||= []
+    name = name.to_sym
+
+    if self.respond_to?(name)
+      raise ArgumentError, "Could not create scope, There is an existing method with this name."
+    end
+
+    scope name, body
+    @whitelist << name
+  end
+
+  def call_whitelisted_scope(scope_name = "")
+    scope_name = scope_name.to_sym unless scope_name == nil
+
+    if @whitelist.include? scope_name
+      self.send(scope_name)
+    else
+      raise NoMethodError, "The scope you provided, '#{scope_name}', does not exist."
+    end
+  end
+end

data/whitelist_scope.gemspec

@@ -0,0 +1,29 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'whitelist_scope/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "whitelist_scope"
+  spec.version       = WhitelistScope::VERSION
+  spec.authors       = ["Melody"]
+  spec.email         = ["meltheadorable@gmail.com"]
+
+  spec.homepage    = "https://github.com/meltheadorable/sortify"
+  spec.summary     = "whitelist_scope provides a safe way to register and call scopes inside rails apps"
+  spec.description = "whitelist_scope acts as a wrapper around ActiveRecord scopes, providing a tiny bit of extra functionality to keep track of whitelisted scopes and call them from user input."
+  spec.license     = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "activerecord", ">= 3.2.0"
+
+  spec.add_development_dependency "sqlite3"
+  spec.add_development_dependency "rspec"
+  spec.add_development_dependency "fuubar"
+  spec.add_development_dependency "coveralls"
+  spec.add_development_dependency "appraisal"
+end

metadata

@@ -0,0 +1,149 @@
+--- !ruby/object:Gem::Specification
+name: whitelist_scope
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Melody
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2015-09-24 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activerecord
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.2.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.2.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'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  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: fuubar
+  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: coveralls
+  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: appraisal
+  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: whitelist_scope acts as a wrapper around ActiveRecord scopes, providing
+  a tiny bit of extra functionality to keep track of whitelisted scopes and call them
+  from user input.
+email:
+- meltheadorable@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Appraisals
+- CODE_OF_CONDUCT.md
+- Gemfile
+- Gemfile.lock
+- LICENSE
+- README.md
+- Rakefile
+- gemfiles/3.2.gemfile
+- gemfiles/4.0.gemfile
+- gemfiles/4.1.gemfile
+- gemfiles/4.2.gemfile
+- lib/whitelist_scope.rb
+- lib/whitelist_scope/version.rb
+- whitelist_scope.gemspec
+homepage: https://github.com/meltheadorable/sortify
+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: whitelist_scope provides a safe way to register and call scopes inside rails
+  apps
+test_files: []
+has_rdoc: