activemodel_flags 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 46ac7c35b1859370a64e3739384db40216cc9321
+  data.tar.gz: 2905520aecf6cbc6164b9b50f8259b11961de6ab
+SHA512:
+  metadata.gz: 06edeb6d64b39ea2ea1a0deeb6c4edce6a8058d93a1f9ce0c898c7f4ba11fe821b6f3681eee3eda03c6a90daed8715e0a9502e94f42171efacdcb6d6bf1bc1f9
+  data.tar.gz: 72ad59696fa3f852cb206f2b0dd06fbf1fabeef1e98e13ed64e16c8fa7381ffd45c211b04b2379b92dad2f5bfbc99d5a3afcbc742b51330bc6c284d5e98f4b34

data/.gitignore

@@ -0,0 +1,9 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,49 @@
+# Contributor Code of Conduct
+
+As contributors and maintainers of this project, and in the interest of
+fostering an open and welcoming community, we pledge to respect all people who
+contribute through reporting issues, posting feature requests, updating
+documentation, submitting pull requests or patches, and other activities.
+
+We are committed to making participation in this project a harassment-free
+experience for everyone, regardless of level of experience, gender, gender
+identity and expression, sexual orientation, disability, personal appearance,
+body size, race, ethnicity, age, religion, or nationality.
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery
+* Personal attacks
+* Trolling or insulting/derogatory comments
+* Public or private harassment
+* Publishing other's private information, such as physical or electronic
+  addresses, without explicit permission
+* Other unethical or unprofessional conduct
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+By adopting this Code of Conduct, project maintainers commit themselves to
+fairly and consistently applying these principles to every aspect of managing
+this project. Project maintainers who do not follow or enforce the Code of
+Conduct may be permanently removed from the project team.
+
+This code of conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community.
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting a project maintainer at najibkaake@gmail.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. Maintainers are
+obligated to maintain confidentiality with regard to the reporter of an
+incident.
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage],
+version 1.3.0, available at
+[http://contributor-covenant.org/version/1/3/0/][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/3/0/

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 Jay El-Kaake
+
+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,148 @@
+![](http://i.imgur.com/jDIg5Xi.png)
+# Active Model Flags Gem
+![Travis build for User Timezone Gem](https://travis-ci.org/jayelkaake/activemodel_flags.svg?branch=master)
+[![Gem Version](https://badge.fury.io/rb/activemodel_flags.svg)](https://badge.fury.io/rb/activemodel_flags)
+The Active Model Flags Gem lets you attach the `has_flags` trait to your User, Account, or any other rails active models.
+
+## Why would you need a flags attribute and this gem?
+For some applications you don't want ot add a million different attributes in your database for flags that are potentially one-time events. For example, if you wanted to track whether a user has been notified of something, or has been sent an email. These arbitrary flag columns start to clutter your DB.
+
+The Active Model Flags gem solves this issue by allowing you to arbitrarily set and get flags from a serialized column.
+
+**Table of Contents**
+* [Installation](#installation)
+* [Usage](#usage)
+* [Customization](#customization)
+* [Other Things](#Other_Things)
+
+# Installation
+#### 1. Install the gem
+Add this line to your application's Gemfile:
+```ruby
+gem 'activemodel_flags'
+```
+And then execute:
+    $ bundle
+Or install it yourself as:
+    $ gem install activemodel_flags
+
+#### 2. Add 'has_flags' to your model
+Choose the model you want to have flags and add the `has_flags` function to it. For example, with a User model this may look like this:
+```ruby
+class User < ActiveRecord::Base
+  # ...
+  has_flags
+  # ...
+end
+```
+
+#### 3. Run the migration to add the DB column
+Then, you'll need to install the column in your database. This gem comes with this generator for you that you can use like this:
+```bash
+rails g activemodel_flags:column User
+rake db:migrate
+```
+Replace `User` with your own model class.
+
+
+
+
+# Usage
+
+## Setters
+Once a model has_flags then you can now set a flag like this:
+```ruby
+user = User.create
+
+user.has! :been_sent_email_about_usage
+
+user.has? :been_sent_email_about_usage
+# false
+```
+or you can do the opposite:
+```ruby
+user = User.create
+
+user.hasnt! :been_sent_email_about_usage
+
+user.has? :been_sent_email_about_usage
+# true
+```
+
+To set the value without saving to the DB use `user.has :been_sent_email_about_usage`.
+
+## Getters
+Consider this example to see how the getters work:
+```ruby
+user = User.create
+
+user.has! :been_sent_email_about_usage
+
+user.has? :been_sent_email_about_usage
+# true
+
+user.hasnt? :been_sent_email_about_usage
+# false
+
+user.has? :been_eating_a_big_chocolate_cake
+# false
+```
+
+## Querying
+Generally this gem is not made for mass querying, so if you plan on doing joins based on the flag attribute then this gem is probably to for you and you should use a boolean column.
+
+### Get models that have or don't have the flag set
+That being said, here's how you can use the
+```ruby
+User.that_havent?(:been_sent_email_about_usage) do |user|
+  # * send that user the email about usage here. *
+  user.has! :been_sent_email_about_usage
+end
+# Returns query list of all users that have been sent a message
+```
+
+### Get all avaialble flags
+If you want to now what flags are being used for **debugging purposes** then you can use
+```ruby
+u = User.flags_used
+# returns something like ["been_sent_email_about_usage", "been_eating_a_big_chocolate_cake"]
+```
+
+### Set the flags for a group of users
+```ruby
+User.where("age > ?", 40).all_have! :seen_james_bond_movies
+# Sets the seen_james_bond_movies flag to true for all matched users.
+```
+And to do the opposite (set the flag to false for all matched users):
+```ruby
+User.that_have?(:used_a_cd).where("age < ", 20).all_have_not! :felt_the_anger_of_skipping_cds
+# Sets the felt_the_anger_of_skipping_cds flag to false for all matched users
+```
+
+### Reset a particular flag for some users
+```ruby
+User.where(took_the_red_pill: true).reset_flags! :been_in_the_matrix
+# Now all users that were matched will return false for has?(:been_in_the_matrix)
+```
+
+### Nuke (reset) all flags
+```ruby
+User.reset_all_flags!
+```
+
+# Customization
+Models that have the has_flags trait will call the protected method `on_flag_change(old_val, new_val)` any time the value of their flag changes, but only if it is done individually.
+
+Feel free to fork and contribute so we can make this better!
+
+# Other Things
+### Roadmap
+* Build in method_missing functionality so you can do things like `model.has_eaten_a_pie!` and `model.has_eaten_a_pie?`
+* Make the flags column customizable so you can add multiple flag columns
+### Contributing
+Bug reports and pull requests are welcome on GitHub at https://github.com/jayelkaake/user_timezone.
+This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to
+adhere to the [Contributor Covenant](contributor-covenant.org) code of conduct.
+
+### License
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,2 @@
+require "bundler/gem_tasks"
+task :default => :spec

data/activemodel_flags.gemspec

@@ -0,0 +1,39 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'activemodel_flags/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "activemodel_flags"
+  spec.version       = ActivemodelFlags::VERSION
+  spec.authors       = ["Jay El-Kaake"]
+  spec.email         = ["najibkaake@gmail.com"]
+
+  spec.summary       = %q{Adds beautifully readable true/false flags to user and account active models (like devise).}
+  spec.description   = %q{This gem adds the ability for models to have an unlimited number of custom flags \
+                        that are stored within one database column cell instead of several columns.}
+  spec.homepage      = "https://www.github.com/jayelkaake/activemodel_flags"
+  spec.license       = "MIT"
+
+  # Prevent pushing this gem to RubyGems.org. To allow pushes either set the 'allowed_push_host'
+  # to allow pushing to a single host or delete this section to allow pushing to any host.
+  # if spec.respond_to?(:metadata)
+  #   spec.metadata['allowed_push_host'] = "TODO: Set to 'http://mygemserver.com'"
+  # else
+  #   raise "RubyGems 2.0 or newer is required to protect against public gem pushes."
+  # end
+
+  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_development_dependency "rails", ">= 4.0.0"
+
+  spec.add_development_dependency "bundler", ">= 1.10"
+  spec.add_development_dependency "temping", "~> 3.3.0"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", '~> 3.4'
+  spec.add_development_dependency "sqlite3"
+
+end

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "activemodel_flags"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/activemodel_flags/has_flags.rb

@@ -0,0 +1,164 @@
+require 'active_support/concern'
+module ActivemodelFlags
+  module HasFlags
+    extend ActiveSupport::Concern
+
+    module ClassMethods
+
+      ##
+      # This will add the ability for the model to set and read flags.
+      # @note: The model must have the 'flags' column. Use rails g activemodel_flags:column *model_name* to generate the migration for the flags column
+      #
+      def has_flags
+        include LocalInstanceMethods
+
+        before_create :init_flags
+        after_initialize :init_flags
+        serialize :flags, JSON
+
+        scope :that_have?, -> (key) {
+          where("flags LIKE '%\"#{key}\":true%'")
+        }
+        scope :that_havent?, -> (key) {
+          where("flags NOT LIKE '%\"#{key}\":true%'")
+        }
+        scope :that_have_not?, -> (key) { that_havent?(key) }
+
+        scope :that_have_any_flags, -> {
+          where("flags != '{}' AND flags IS NOT NULL")
+        }
+
+        scope :all_have!, -> (flag) {
+          self.reset_flags!(flag)
+          self.update_all("flags = REPLACE(flags, '}', '\"#{flag}\":true}')")
+        }
+        scope :all_have_not!, -> (flag) {
+          self.reset_flags!(flag)
+          self.update_all("flags = REPLACE(flags, '}', '\"#{flag}\":false}')")
+        }
+
+        def self.flags_used
+          all_flags = {}
+
+          self.that_have_any_flags.each do |obj|
+            obj.flags.keys.each do |key|
+              all_flags[key] = true unless all_flags[key]
+            end
+          end
+
+          all_flags.keys
+        end
+
+        def self.reset_flags!(flag)
+          self.update_all("flags = REPLACE(\
+                                     REPLACE(\
+                                       REPLACE(\
+                                         REPLACE(
+                                          flags, '\"#{flag}\":false', ''\
+                                         ), '\"#{flag}\":false,', ''\
+                                       ), '\"#{flag}\":true,', ''\
+                                     ), '\"#{flag}\":true', ''\
+                                    )")
+        end
+
+        def self.reset_all_flags!
+          self.update_all(flags: '{}')
+        end
+      end
+    end
+
+    module LocalInstanceMethods
+
+      #### getters
+      def has_flag?(flag)
+        self.flags[flag.to_s] != nil
+      end
+      def has?(flag)
+        self.flags[flag.to_s]
+      end
+
+      def hasnt?(flag)
+        !has?(flag)
+      end
+      alias_method :has_not?, :hasnt?
+
+
+      #### setters
+
+      def has(flag)
+        old_flags = self.flags
+
+        self.flags[flag.to_s] = true
+
+        on_flag_change(old_flags[flag.to_s], self.flags[flag.to_s]) unless old_flags == self.flags
+      end
+
+      def has!(flag)
+        has(flag)
+
+        self.save!
+      end
+
+      def hasnt!(flag)
+        old_flags = self.flags
+
+        self.flags[flag.to_s] = false
+
+        on_flag_change(old_flags[flag.to_s], self.flags[flag.to_s]) unless old_flags == self.flags
+        self.save!
+      end
+      alias_method :has_not!, :hasnt!
+
+      def unset_flag!(flag)
+        old_flags = self.flags
+
+        self.flags.delete(flag.to_s)
+
+        on_flag_change(old_flags[flag.to_s], self.flags[flag.to_s]) unless old_flags == self.flags
+        self.save!
+      end
+
+      # TODO implement the ability to
+      # def method_missing(method)
+      #   if method.to_s =~ /has_[a-zA-Z0-9_]+\?/
+      #     key = method.to_s.chomp("?").reverse.chomp("_sah").reverse
+      #     has = true
+      #   elsif method.to_s =~ /hasnt_[a-zA-Z0-9_]+\?/
+      #     key = method.to_s.chomp("?").reverse.chomp("_tnsah").reverse
+      #     has = false
+      #   elsif method.to_s =~ /has_not_[a-zA-Z0-9_]+\?/
+      #     key = method.to_s.chomp("?").reverse.chomp("_ton_sah").reverse
+      #     has = false
+      #   else
+      #     return super
+      #   end
+      #
+      #   if has_flag?(method.to_s)
+      #     has ? has?(key) : hasnt?(key)
+      #   else
+      #     puts "*************** NO METHOD!! "
+      #     super
+      #   end
+      # end
+
+      def respond_to?(method)
+        has_flag?(method.to_s) || super(method)
+      end
+
+      protected
+
+      def on_flag_change(old_val, new_val)
+        # Override this method if you want to react to flag changes
+      end
+
+      private
+
+      def init_flags
+        self.flags = {} unless self.flags.present?
+      end
+
+    end
+  end
+end
+
+ActiveRecord::Base.send :include, ActivemodelFlags::HasFlags

data/lib/activemodel_flags/version.rb

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

data/lib/activemodel_flags.rb

@@ -0,0 +1,7 @@
+require "activemodel_flags/version"
+
+module ActivemodelFlags
+  if defined?(Rails)
+    require 'activemodel_flags/has_flags'
+  end
+end

data/lib/generators/activemodel_flags/column_generator.rb

@@ -0,0 +1,35 @@
+module ActivemodelFlags
+  class ColumnGenerator < Rails::Generators::NamedBase
+    include Rails::Generators::Migration
+    desc "Generates the migration to add a flags column to a rails model."
+    source_root File.expand_path('../templates', __FILE__)
+
+    def manifest
+      migration_template 'migration.rb', "db/migrate/add_flags_to_#{custom_file_name}.rb", {
+          :assigns => flags_local_assigns,
+          :migration_file_name => "add_flags_field_to_#{custom_file_name}"
+      }
+    end
+
+    def self.next_migration_number(dir)
+      Time.now.utc.strftime("%Y%m%d%H%M%S")
+    end
+
+    private
+
+    def custom_file_name
+      custom_name = class_name.underscore.downcase
+      custom_name = custom_name.pluralize if ActiveRecord::Base.pluralize_table_names
+      custom_name
+    end
+
+    def flags_local_assigns
+      {}.tap do |assigns|
+        assigns[:migration_action] = "add"
+        assigns[:class_name] = "add_flags_fields_to_#{custom_file_name}"
+        assigns[:table_name] = custom_file_name
+        assigns[:attributes] = [Rails::Generators::GeneratedAttribute.new("flags", "text")]
+      end
+    end
+  end
+end

data/lib/generators/activemodel_flags/templates/migration.rb

@@ -0,0 +1,14 @@
+class AddFlagsTo<%= table_name.camelize %> < ActiveRecord::Migration
+
+  def up
+    add_column :<%= table_name %>, :flags, :text
+
+    <%= class_name.camelize.singularize %>.all.each do |obj|
+      obj.update!(flags: {})
+    end
+  end
+
+  def down
+    remove_column :<%= table_name %>, :flags
+  end
+end

metadata

@@ -0,0 +1,146 @@
+--- !ruby/object:Gem::Specification
+name: activemodel_flags
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Jay El-Kaake
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2016-04-30 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 4.0.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 4.0.0
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.10'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.10'
+- !ruby/object:Gem::Dependency
+  name: temping
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.3.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.3.0
+- !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.4'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.4'
+- !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: |-
+  This gem adds the ability for models to have an unlimited number of custom flags \
+                          that are stored within one database column cell instead of several columns.
+email:
+- najibkaake@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- activemodel_flags.gemspec
+- bin/console
+- bin/setup
+- lib/activemodel_flags.rb
+- lib/activemodel_flags/has_flags.rb
+- lib/activemodel_flags/version.rb
+- lib/generators/activemodel_flags/column_generator.rb
+- lib/generators/activemodel_flags/templates/migration.rb
+homepage: https://www.github.com/jayelkaake/activemodel_flags
+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.6
+signing_key: 
+specification_version: 4
+summary: Adds beautifully readable true/false flags to user and account active models
+  (like devise).
+test_files: []
+has_rdoc: