acts_as_toggleable 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 95218fee4742311ff12d26e4a6f6f5a97c47abca
+  data.tar.gz: 49cd4e68d367a500cef51cf57783529ec39e7df1
+SHA512:
+  metadata.gz: 1438a570886c4a296f7834494e26067f064fd13e82c4f445f2922dae69b3930853d63dae8a45b15c185f8992e653ddb5cc8fef9bb2ca9f0d8b0bd0273af8fcd6
+  data.tar.gz: c0766f55b348ec89e8a3c8e8a6677be24590b1d483afb775a8215ffb662a51f488dcda688262df6cff1fe047dda9d15b3afa86730bc16143211f74727af60a23

data/.gitignore

@@ -0,0 +1,18 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+.DS_Store

data/.rubocop.yml

@@ -0,0 +1,45 @@
+AllCops:
+  DisplayCopNames: true
+
+LineLength:
+  Max: 175
+
+ClassLength:
+  CountComments: false  # count full line comments?
+  Max: 175
+
+MethodLength:
+  CountComments: false  # count full line comments?
+  Max: 20
+
+HashSyntax:
+  EnforcedStyle: hash_rockets
+
+Documentation:
+  Enabled: false
+
+CollectionMethods:
+  PreferredMethods:
+    map: 'collect'
+    map!: 'collect!'
+    reduce: 'inject'
+    find: 'detect'
+    find_all: 'select'
+
+Output:
+  Enabled: false
+
+HasAndBelongsToMany:
+  Enabled: false
+
+Style/ClassAndModuleChildren:
+  Enabled: false
+
+Style/RegexpLiteral:
+  EnforcedStyle: percent_r
+
+Style/SpaceInsideStringInterpolation:
+  Enabled: false
+
+Metrics/AbcSize:
+  Max: 17

data/.ruby-version

@@ -0,0 +1 @@
+2.3.1

data/.travis.yml

@@ -0,0 +1,8 @@
+language: ruby
+cache: bundler
+
+rvm:
+  - 2.2.5
+  - 2.3.1
+
+script: 'CODECLIMATE_REPO_TOKEN=8c51f7e5074d530e9a01e792bc36b68890e2e40a19a4afac695f24098bd7cb2a bundle exec rake'

data/CHANGELOG.md

@@ -0,0 +1,5 @@
+# CHANGELOG
+
+## 0.1.0 (2016-08-01)
+
+* Initial release

data/Gemfile

@@ -0,0 +1,3 @@
+source 'https://rubygems.org'
+
+gemspec

data/Guardfile

@@ -0,0 +1,17 @@
+guard :rubocop do
+  watch(%r{.+\.gemspec$})
+  watch(%r{.+\.rb$})
+  watch(%r{(?:.+/)?\.rubocop\.yml$}) { |m| File.dirname(m[0]) }
+end
+
+guard :minitest do
+  # with Minitest::Unit
+  watch(%r{^test/(.*)\/?test_(.*)\.rb$})
+  watch(%r{^lib/(.*/)?([^/]+)\.rb$})     { |m| "test/#{m[1]}test_#{m[2]}.rb" }
+  watch(%r{^test/test_helper\.rb$})      { 'test' }
+
+  # with Minitest::Spec
+  # watch(%r{^spec/(.*)_spec\.rb$})
+  # watch(%r{^lib/(.+)\.rb$})         { |m| "spec/#{m[1]}_spec.rb" }
+  # watch(%r{^spec/spec_helper\.rb$}) { 'spec' }
+end

data/LICENSE

@@ -0,0 +1,21 @@
+The MIT License
+
+Copyright (c) 2016 PJ Kelly (Crush & Lovely)
+
+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,113 @@
+# Acts As Toggleable
+
+[![RubyGem Version](http://img.shields.io/gem/v/acts_as_toggleable.svg?style=flat)](https://rubygems.org/gems/acts_as_toggleable)
+[![Dependency Status](http://img.shields.io/gemnasium/crushlovely/acts_as_toggleable.svg?style=flat)](https://gemnasium.com/crushlovely/acts_as_toggleable)
+[![Build Status](http://img.shields.io/travis/crushlovely/acts_as_toggleable.svg?style=flat)](https://travis-ci.org/crushlovely/acts_as_toggleable)
+[![Code Climate](http://img.shields.io/codeclimate/github/crushlovely/acts_as_toggleable.svg?style=flat)](https://codeclimate.com/github/crushlovely/acts_as_toggleable)
+[![Code Coverage](http://img.shields.io/codeclimate/coverage/github/crushlovely/acts_as_toggleable.svg?style=flat)](https://codeclimate.com/github/crushlovely/acts_as_toggleable)
+
+Create toggleable attributes for your ActiveRecord models.
+
+## Why?
+
+We frequently require the ability to toggle the visibility of content on an application's front-end.
+
+## Installation
+
+`gem install acts_as_toggleable`
+
+or in your `Gemfile`
+
+``` ruby
+gem 'acts_as_toggleable'
+```
+
+## Usage
+
+Make sure you require the library.
+
+``` ruby
+require 'acts_as_toggleable'
+```
+
+This gem follows a similar API to many ActiveRecord plugins:
+
+``` ruby
+class Widget < ActiveRecord::Base
+  acts_as_toggleable :visible
+  # acts_as_toggleable :visible, :default => false
+end
+```
+
+This sets up a boolean field on the model, and also makes the following instance methods available:
+
+``` ruby
+widget = Widget.new
+widget.visible
+# => true
+
+# toggle the widget's visibility, but don't persist the change
+widget.toggle(:visible)
+widget.visible
+# => false
+
+# toggle the widget's visibility and persist the change
+widget.toggle!(:visible)
+```
+
+### Options
+
+In addition to the name of the attribute to create, you can also pass the following options:
+
+* `:scope_name`: The Symbol representing the name of the positive scope (optional, default: toggleable_attribute).
+* `:inverse_scope_name`: The Symbol representing the name of the negative scope (optional, default: "not_#{toggleable_attribute}").
+
+### Scopes
+
+Two scopes are automatically created when you define a toggleable attribute:
+
+``` ruby
+class Widget < ActiveRecord::Base
+  acts_as_toggleable :visible
+end
+
+widget1 = Widget.create(:visible => true)
+widget2 = Widget.create(:visible => false)
+
+Widget.visible
+# => [widget1]
+
+Widget.not_visible
+# => [widget2]
+```
+
+These are just plain old ActiveRecord scopes, so you can chain them together with other scopes as needed:
+
+``` ruby
+Widget.visible.where(:created_at.lte => 10.days.ago)
+```
+
+You can also customize the names of the scope created:
+
+``` ruby
+class Widget < ActiveRecord::Base
+  acts_as_toggleable :published, :inverse_scope_name => :unpublished
+end
+
+Widget.published
+Widget.unpublished
+```
+
+## Contributing to acts_as_toggleable
+
+* Check out the latest master to make sure the feature hasn't been implemented or the bug hasn't been fixed yet
+* Check out the issue tracker to make sure someone already hasn't requested it and/or contributed it
+* Fork the project
+* Start a feature/bugfix branch
+* Commit and push until you are happy with your contribution
+* Make sure to add tests for it. This is important so we don't break it in a future version unintentionally.
+* Please try not to mess with the Rakefile, version, or history. If you want to have your own version, or is otherwise necessary, that is fine, but please isolate to its own commit so we can cherry-pick around it.
+
+## Copyright
+
+Copyright (c) 2016 PJ Kelly (Crush & Lovely). See LICENSE for further details.

data/Rakefile

@@ -0,0 +1,10 @@
+require 'bundler/gem_tasks'
+require 'rake/testtask'
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'test'
+  t.test_files = FileList['test/**/*_test.rb']
+  t.warning = false
+end
+
+task :default => :test

data/acts_as_toggleable.gemspec

@@ -0,0 +1,34 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+
+require 'acts_as_toggleable/version'
+
+Gem::Specification.new do |spec|
+  spec.name        = 'acts_as_toggleable'
+  spec.version     = ActsAsToggleable::VERSION
+  spec.authors     = ['PJ Kelly']
+  spec.email       = ['pj@crushlovely.com']
+  spec.homepage    = 'https://github.com/crushlovely/acts_as_toggleable'
+  spec.summary     = 'Toggleable attributes for your ActiveRecord models.'
+  spec.description = 'Toggleable attributes for your ActiveRecord models.'
+
+  spec.rubyforge_project = 'acts_as_toggleable'
+
+  spec.files         = `git ls-files`.split("\n")
+  spec.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  spec.executables   = `git ls-files -- bin/*`.split("\n").collect { |f| File.basename(f) }
+  spec.require_paths = ['lib']
+
+  spec.add_runtime_dependency('activerecord', '>= 4.2.0.beta4')
+
+  spec.add_dependency('activesupport', '>= 4.2.0.beta4')
+
+  spec.add_development_dependency 'sqlite3'
+  spec.add_development_dependency 'minitest-utils'
+  spec.add_development_dependency 'rake'
+  spec.add_development_dependency('rubocop')
+  spec.add_development_dependency('guard-rubocop')
+  spec.add_development_dependency('guard-minitest')
+  spec.add_development_dependency('codeclimate-test-reporter')
+end

data/lib/acts_as_toggleable.rb

@@ -0,0 +1,17 @@
+require 'active_record'
+require 'active_support/core_ext/array/extract_options'
+require 'acts_as_toggleable/active_record/acts/toggleable'
+
+module ActsAsToggleable
+  if defined?(Rails::Railtie)
+    class Railtie < Rails::Railtie
+      initializer 'acts_as_toggleable.insert_into_active_record' do
+        ActiveSupport.on_load :active_record do
+          ActiveRecord::Base.send(:include, ActiveRecord::Acts::Toggleable)
+        end
+      end
+    end
+  elsif defined?(ActiveRecord)
+    ActiveRecord::Base.send(:include, ActiveRecord::Acts::Toggleable)
+  end
+end

data/lib/acts_as_toggleable/active_record/acts/toggleable.rb

@@ -0,0 +1,56 @@
+module ActiveRecord
+  module Acts
+    module Toggleable
+      extend ActiveSupport::Concern
+
+      included do
+        extend ClassMethods
+      end
+
+      module ClassMethods
+        # Public: Create a toggleable attribute on the model.
+        #
+        # toggleable_attribute - A symbol representing the name of the attribute to be created.
+        # options - The Hash options used to customize the attribute (default: {}):
+        #           :scope_name          - The Symbol representing the name of the positive scope
+        #                                  (optional, default: #{toggleable_attribute}).
+        #           :inverse_scope_name  - The Symbol representing the name of the negative scope
+        #                                  (optional, default: #{toggleable_attribute}).
+        #
+        # Examples:
+        #
+        #   acts_as_toggleable :for_sale, :default => false
+        #   acts_as_toggleable :visible, :inverse_scope_name => :hidden
+        #   acts_as_toggleable :publishable, :default => false, :inverse_scope_name => :unpublishable
+        #   acts_as_toggleable :featured, :default => true, :scope_name => :features
+        #
+        # Defines the attribute specified as well as relevant scopes.
+        def acts_as_toggleable(toggleable_attribute, options = {})
+          defaults = {
+            :scope_name => toggleable_attribute,
+            :inverse_scope_name => "not_#{toggleable_attribute}"
+          }
+          options = defaults.merge(options)
+
+          scope options[:scope_name], -> { where(toggleable_attribute => true) }
+          scope options[:inverse_scope_name], -> { where(toggleable_attribute => false) }
+        end
+      end
+
+      # Public: Toggle the attribute specified
+      #
+      # Returns the value the attribute was changed to. Does not persist the change.
+      def toggle(toggleable_attribute)
+        send("#{toggleable_attribute}=", !send(toggleable_attribute))
+      end
+
+      # Public: Toggle the attribute specified and persist the change
+      #
+      # Returns the result of #save.
+      def toggle!(toggleable_attribute)
+        toggle(toggleable_attribute)
+        save
+      end
+    end
+  end
+end

data/lib/acts_as_toggleable/version.rb

@@ -0,0 +1,3 @@
+module ActsAsToggleable
+  VERSION = '0.1.0'.freeze
+end

data/test/permalink/active_record_test.rb

@@ -0,0 +1,51 @@
+require 'test_helper'
+
+class ActiveRecordTest < Minitest::Test
+  setup do
+    Article.delete_all
+  end
+
+  let(:visible_article) { Article.create(:visible => true) }
+  let(:hidden_article) { Article.create(:visible => false) }
+
+  test 'scopes creation based on the parameters passed in' do
+    assert_respond_to Article, :visible
+    assert_respond_to Article, :hidden
+    assert_respond_to Story, :publishable
+    assert_respond_to Story, :unpublishable
+    assert_respond_to Story, :features
+    assert_respond_to Story, :not_featured
+  end
+
+  test 'positive scope returns the appropriate records' do
+    assert_includes Article.visible, visible_article
+    refute_includes Article.visible, hidden_article
+  end
+
+  test 'negative scope returns the appropriate records' do
+    assert_includes Article.hidden, hidden_article
+    refute_includes Article.hidden, visible_article
+  end
+
+  test '#toggle toggles the value of the toggleable field' do
+    assert_equal visible_article.visible, true
+    visible_article.toggle(:visible)
+    assert_equal visible_article.visible, false
+
+    assert_equal hidden_article.visible, false
+    hidden_article.toggle(:visible)
+    assert_equal hidden_article.visible, true
+  end
+
+  test '#toggle! toggles the value of the toggleable field' do
+    assert_equal visible_article.visible, true
+    visible_article.toggle!(:visible)
+    visible_article.reload
+    assert_equal visible_article.visible, false
+
+    assert_equal hidden_article.visible, false
+    hidden_article.toggle!(:visible)
+    hidden_article.reload
+    assert_equal hidden_article.visible, true
+  end
+end

data/test/support/article.rb

@@ -0,0 +1,3 @@
+class Article < ActiveRecord::Base
+  acts_as_toggleable :visible, :inverse_scope_name => :hidden
+end

data/test/support/schema.rb

@@ -0,0 +1,10 @@
+ActiveRecord::Schema.define(:version => 0) do
+  create_table :stories do |t|
+    t.boolean :publishable, :null => false, :default => false
+    t.boolean :featured, :null => false, :default => false
+  end
+
+  create_table :articles do |t|
+    t.boolean :visible, :null => false, :default => false
+  end
+end

data/test/support/story.rb

@@ -0,0 +1,4 @@
+class Story < ActiveRecord::Base
+  acts_as_toggleable :publishable, :inverse_scope_name => :unpublishable
+  acts_as_toggleable :featured, :scope_name => :features
+end

data/test/test_helper.rb

@@ -0,0 +1,15 @@
+require 'bundler/setup'
+
+require 'codeclimate-test-reporter'
+CodeClimate::TestReporter.start
+
+require 'acts_as_toggleable'
+
+require 'minitest/utils'
+require 'minitest/autorun'
+
+ActiveRecord::Base.establish_connection(:adapter => 'sqlite3', :database => ':memory:')
+
+load('support/schema.rb')
+require 'support/article'
+require 'support/story'

metadata

@@ -0,0 +1,193 @@
+--- !ruby/object:Gem::Specification
+name: acts_as_toggleable
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- PJ Kelly
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2016-05-16 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activerecord
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 4.2.0.beta4
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 4.2.0.beta4
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 4.2.0.beta4
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 4.2.0.beta4
+- !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: minitest-utils
+  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: rake
+  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: rubocop
+  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: guard-rubocop
+  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: guard-minitest
+  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: codeclimate-test-reporter
+  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: Toggleable attributes for your ActiveRecord models.
+email:
+- pj@crushlovely.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rubocop.yml"
+- ".ruby-version"
+- ".travis.yml"
+- CHANGELOG.md
+- Gemfile
+- Guardfile
+- LICENSE
+- README.md
+- Rakefile
+- acts_as_toggleable.gemspec
+- lib/acts_as_toggleable.rb
+- lib/acts_as_toggleable/active_record/acts/toggleable.rb
+- lib/acts_as_toggleable/version.rb
+- test/permalink/active_record_test.rb
+- test/support/article.rb
+- test/support/schema.rb
+- test/support/story.rb
+- test/test_helper.rb
+homepage: https://github.com/crushlovely/acts_as_toggleable
+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: acts_as_toggleable
+rubygems_version: 2.5.1
+signing_key: 
+specification_version: 4
+summary: Toggleable attributes for your ActiveRecord models.
+test_files:
+- test/permalink/active_record_test.rb
+- test/support/article.rb
+- test/support/schema.rb
+- test/support/story.rb
+- test/test_helper.rb