bitmask_attribute 1.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: d0c71c63655e415f12efd67775d0a4b78595c476
+  data.tar.gz: 613e986dd470ea0c496adea31917833ccfcdd50c
+SHA512:
+  metadata.gz: 1cb14946f64b7a8dab3e5deca483cca5dc146a77df669ba38affe0391d114d1a01b449f6094d840f160d54bdf8443148eadb25a4d34c31302f535b01d8cc9cbe
+  data.tar.gz: 9c0cb231bb95b5f7484a72a16d782c453c91dd0fc89ac9b44f53a644b958a8b90138cdcaadc10517fcd5e14002c886ab8c7c0f5b587bb0e596b9ab41ba97870a

data/.gitignore

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

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--require spec_helper

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2016 Madeline Carson
+
+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,53 @@
+# BitmaskAttribute
+
+This gem adds helper methods to your class to facilitate the use of bitmask attributes.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'bitmask_attribute'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install bitmask_attribute
+
+## Usage
+
+Include the concern in your class, and define which attribute is the bitmask attribute.
+This attribute is expected to be an integer type.
+
+```
+# has int attribute called actions
+Class Foo
+  include BitmaskAttribute::Concern
+
+  ...
+
+  bitmask_attribute :actions
+```
+
+You now get the following methods at your disposal:
+
+`foo_instance.action_present?(1)`
+-> returns boolean describing whether the actions attribute includes the input bit flag.
+
+`foo_instance.add_action(1)`
+-> adds the input bit flag to the mask
+
+`foo_instance.remove_action(1)`
+-> removes the input bit flag from the mask
+
+## Contributing
+
+1. Fork it ( https://github.com/[my-github-username]/bitmask_attribute/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,2 @@
+require "bundler/gem_tasks"
+

data/bitmask_attribute.gemspec

@@ -0,0 +1,26 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'bitmask_attribute/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "bitmask_attribute"
+  spec.version       = BitmaskAttribute::VERSION
+  spec.authors       = ["Madeline Carson"]
+  spec.email         = ["madeline.carson@gmail.com"]
+  spec.summary       = %q{Bitmask attribute helper methods for Rails models.}
+  spec.description   = %q{Bitmask attribute helper methods for Rails models. Gives model access to methods to
+                          check, add, and remove flags.}
+  spec.homepage      = ""
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| f[3..-1] }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.7"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+  spec.add_dependency "activesupport", "~> 4.2"
+end

data/lib/bitmask_attribute.rb

@@ -0,0 +1,6 @@
+require "bitmask_attribute/version"
+require "bitmask_attribute/concern"
+
+module BitmaskAttribute
+  # Your code goes here...
+end

data/lib/bitmask_attribute/concern.rb

@@ -0,0 +1,28 @@
+require 'active_support/concern'
+require 'active_support/inflector'
+
+module BitmaskAttribute
+  module Concern
+    extend ActiveSupport::Concern
+
+    module ClassMethods
+
+      def bitmask_attribute(name)
+        single_name = name.to_s.singularize
+        define_method "#{single_name}_present?" do |bit_sequence|
+          send(name) & bit_sequence == bit_sequence
+        end
+
+        define_method "add_#{single_name}" do |bit_sequence|
+          current_bits = send(name)
+          send("#{name}=", current_bits | bit_sequence)
+        end
+
+        define_method "remove_#{single_name}" do |bit_sequence|
+          current_bits = send(name)
+          send("#{name}=", current_bits & ~bit_sequence)
+        end
+      end
+    end
+  end
+end

data/lib/bitmask_attribute/version.rb

@@ -0,0 +1,3 @@
+module BitmaskAttribute
+  VERSION = "1.0.1"
+end

data/spec/bitmask_attribute/concern_spec.rb

@@ -0,0 +1,73 @@
+require "spec_helper"
+require "bitmask_attribute/concern"
+
+RSpec.describe BitmaskAttribute::Concern do
+  let(:foo) { Foo.new }
+
+  describe "bitmask attribute present" do
+
+    context "where bit is present" do
+      before { foo.bitmask_attributes = 3 }
+
+      it "returns true" do
+        expect(foo.bitmask_attribute_present?(1)).to eql(true)
+      end
+    end
+
+    context "where bit is not present" do
+      before { foo.bitmask_attributes = 2 }
+
+      it "returns false" do
+        expect(foo.bitmask_attribute_present?(1)).to eql(false)
+      end
+    end
+  end
+
+  describe "add bitmask attribute" do
+    context "where the bit isn't present" do
+      before { foo.bitmask_attributes = 2 }
+
+      it "adds the bit to the bitmask" do
+        foo.add_bitmask_attribute(1)
+        expect(foo.bitmask_attributes).to eql(3)
+      end
+    end
+
+    context "where the bit is present" do
+      before { foo.bitmask_attributes = 3 }
+
+      it "doesn't add the bit to the bitmask" do
+        foo.add_bitmask_attribute(1)
+        expect(foo.bitmask_attributes).to eql(3)
+      end
+    end
+  end
+
+  describe "remove bitmask attribute" do
+    context "where the bit is present" do
+      before { foo.bitmask_attributes = 3 }
+
+      it "removes the bit from the bitmask" do
+        foo.remove_bitmask_attribute(1)
+        expect(foo.bitmask_attributes).to eql(2)
+      end
+    end
+
+    context "where the bit isn't present" do
+      before { foo.bitmask_attributes = 2 }
+
+      it "doesn't remove the bit from the bitmask" do
+        foo.remove_bitmask_attribute(1)
+        expect(foo.bitmask_attributes).to eql(2)
+      end
+    end
+  end
+
+  class Foo
+    include BitmaskAttribute::Concern
+
+    attr_accessor :bitmask_attributes
+
+    bitmask_attribute :bitmask_attributes
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,103 @@
+# This file was generated by the `rspec --init` command. Conventionally, all
+# specs live under a `spec` directory, which RSpec adds to the `$LOAD_PATH`.
+# The generated `.rspec` file contains `--require spec_helper` which will cause
+# this file to always be loaded, without a need to explicitly require it in any
+# files.
+#
+# Given that it is always loaded, you are encouraged to keep this file as
+# light-weight as possible. Requiring heavyweight dependencies from this file
+# will add to the boot time of your test suite on EVERY test run, even for an
+# individual file that may not need all of that loaded. Instead, consider making
+# a separate helper file that requires the additional dependencies and performs
+# the additional setup, and require it from the spec files that actually need
+# it.
+#
+# The `.rspec` file also contains a few flags that are not defaults but that
+# users commonly want.
+#
+# See http://rubydoc.info/gems/rspec-core/RSpec/Core/Configuration
+RSpec.configure do |config|
+  # rspec-expectations config goes here. You can use an alternate
+  # assertion/expectation library such as wrong or the stdlib/minitest
+  # assertions if you prefer.
+  config.expect_with :rspec do |expectations|
+    # This option will default to `true` in RSpec 4. It makes the `description`
+    # and `failure_message` of custom matchers include text for helper methods
+    # defined using `chain`, e.g.:
+    #     be_bigger_than(2).and_smaller_than(4).description
+    #     # => "be bigger than 2 and smaller than 4"
+    # ...rather than:
+    #     # => "be bigger than 2"
+    expectations.include_chain_clauses_in_custom_matcher_descriptions = true
+  end
+
+  # rspec-mocks config goes here. You can use an alternate test double
+  # library (such as bogus or mocha) by changing the `mock_with` option here.
+  config.mock_with :rspec do |mocks|
+    # Prevents you from mocking or stubbing a method that does not exist on
+    # a real object. This is generally recommended, and will default to
+    # `true` in RSpec 4.
+    mocks.verify_partial_doubles = true
+  end
+
+  # This option will default to `:apply_to_host_groups` in RSpec 4 (and will
+  # have no way to turn it off -- the option exists only for backwards
+  # compatibility in RSpec 3). It causes shared context metadata to be
+  # inherited by the metadata hash of host groups and examples, rather than
+  # triggering implicit auto-inclusion in groups with matching metadata.
+  config.shared_context_metadata_behavior = :apply_to_host_groups
+
+# The settings below are suggested to provide a good initial experience
+# with RSpec, but feel free to customize to your heart's content.
+=begin
+  # This allows you to limit a spec run to individual examples or groups
+  # you care about by tagging them with `:focus` metadata. When nothing
+  # is tagged with `:focus`, all examples get run. RSpec also provides
+  # aliases for `it`, `describe`, and `context` that include `:focus`
+  # metadata: `fit`, `fdescribe` and `fcontext`, respectively.
+  config.filter_run_when_matching :focus
+
+  # Allows RSpec to persist some state between runs in order to support
+  # the `--only-failures` and `--next-failure` CLI options. We recommend
+  # you configure your source control system to ignore this file.
+  config.example_status_persistence_file_path = "spec/examples.txt"
+
+  # Limits the available syntax to the non-monkey patched syntax that is
+  # recommended. For more details, see:
+  #   - http://rspec.info/blog/2012/06/rspecs-new-expectation-syntax/
+  #   - http://www.teaisaweso.me/blog/2013/05/27/rspecs-new-message-expectation-syntax/
+  #   - http://rspec.info/blog/2014/05/notable-changes-in-rspec-3/#zero-monkey-patching-mode
+  config.disable_monkey_patching!
+
+  # This setting enables warnings. It's recommended, but in some cases may
+  # be too noisy due to issues in dependencies.
+  config.warnings = true
+
+  # Many RSpec users commonly either run the entire suite or an individual
+  # file, and it's useful to allow more verbose output when running an
+  # individual spec file.
+  if config.files_to_run.one?
+    # Use the documentation formatter for detailed output,
+    # unless a formatter has already been configured
+    # (e.g. via a command-line flag).
+    config.default_formatter = 'doc'
+  end
+
+  # Print the 10 slowest examples and example groups at the
+  # end of the spec run, to help surface which specs are running
+  # particularly slow.
+  config.profile_examples = 10
+
+  # 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
+
+  # Seed global randomization in this process using the `--seed` CLI option.
+  # Setting this allows you to use `--seed` to deterministically reproduce
+  # test failures related to randomization by passing the same `--seed` value
+  # as the one that triggered the failure.
+  Kernel.srand config.seed
+=end
+end

metadata

@@ -0,0 +1,117 @@
+--- !ruby/object:Gem::Specification
+name: bitmask_attribute
+version: !ruby/object:Gem::Version
+  version: 1.0.1
+platform: ruby
+authors:
+- Madeline Carson
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2016-08-24 00:00:00.000000000 Z
+dependencies:
+- !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.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.2'
+description: |-
+  Bitmask attribute helper methods for Rails models. Gives model access to methods to
+                            check, add, and remove flags.
+email:
+- madeline.carson@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bitmask_attribute.gemspec
+- lib/bitmask_attribute.rb
+- lib/bitmask_attribute/concern.rb
+- lib/bitmask_attribute/version.rb
+- spec/bitmask_attribute/concern_spec.rb
+- spec/spec_helper.rb
+homepage: ''
+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: Bitmask attribute helper methods for Rails models.
+test_files:
+- spec/bitmask_attribute/concern_spec.rb
+- spec/spec_helper.rb
+has_rdoc: