user_prefs 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: cc4765f05bbab5c99f1ed18b00a42f573179ae5c
+  data.tar.gz: 8d4fb0fb1ec6e8837a025c2921173a869befce98
+SHA512:
+  metadata.gz: 206f57111bc14730b5ed6fdfee79aa1ec41304c44f8223ac69321d0c58fbd8a30e8e9817ab139ae4c9f70510409022d66612323a221d7cc29d12e95342901028
+  data.tar.gz: e9465626a7c93c437537d02bd1458c42267365101395d69f42d5dcf1095cb32acae2702910268783878495760bd16becec0fcad33a886700f123c25719912769

data/.gitignore

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

data/.rubocop.yml

@@ -0,0 +1,101 @@
+Style/MultilineBlockChain:
+  Description: 'Avoid multi-line chains of blocks.'
+  StyleGuide: 'https://github.com/bbatsov/ruby-style-guide#single-line-blocks'
+  Enabled: false
+
+Style/Documentation:
+  Description: 'Document classes and non-namespace modules.'
+  Enabled: false
+  Exclude:
+    - 'spec/**/*'
+    - 'test/**/*'
+
+# Multi-line method chaining should be done with trailing dots.
+Style/DotPosition:
+  EnforcedStyle: leading
+  SupportedStyles:
+    - leading
+    - trailing
+
+Style/MutableConstant:
+  Description: 'Do not assign mutable objects to constants.'
+  Enabled: false
+
+Metrics/AbcSize:
+  # The ABC size is a calculated magnitude, so this number can be a Fixnum or
+  # a Float.
+  Max: 20
+
+Metrics/LineLength:
+  Max: 100
+
+Style/BlockDelimiters:
+  EnforcedStyle: line_count_based
+  SupportedStyles:
+    # The `line_count_based` style enforces braces around single line blocks and
+    # do..end around multi-line blocks.
+    - line_count_based
+    # The `semantic` style enforces braces around functional blocks, where the
+    # primary purpose of the block is to return a value and do..end for
+    # procedural blocks, where the primary purpose of the block is its
+    # side-effects.
+    #
+    # This looks at the usage of a block's method to determine its type (e.g. is
+    # the result of a `map` assigned to a variable or passed to another
+    # method) but exceptions are permitted in the `ProceduralMethods`,
+    # `FunctionalMethods` and `IgnoredMethods` sections below.
+    - semantic
+    # The `braces_for_chaining` style enforces braces around single line blocks
+    # and do..end around multi-line blocks, except for multi-line blocks whose
+    # return value is being chained with another method (in which case braces
+    # are enforced).
+    - braces_for_chaining
+  ProceduralMethods:
+    # Methods that are known to be procedural in nature but look functional from
+    # their usage, e.g.
+    #
+    #   time = Benchmark.realtime do
+    #     foo.bar
+    #   end
+    #
+    # Here, the return value of the block is discarded but the return value of
+    # `Benchmark.realtime` is used.
+    - benchmark
+    - bm
+    - bmbm
+    - create
+    - each_with_object
+    - measure
+    - new
+    - realtime
+    - tap
+    - with_object
+  FunctionalMethods:
+    # Methods that are known to be functional in nature but look procedural from
+    # their usage, e.g.
+    #
+    #   let(:foo) { Foo.new }
+    #
+    # Here, the return value of `Foo.new` is used to define a `foo` helper but
+    # doesn't appear to be used from the return value of `let`.
+    - let
+    - let!
+    - subject
+    - watch
+  IgnoredMethods:
+    # Methods that can be either procedural or functional and cannot be
+    # categorised from their usage alone, e.g.
+    #
+    #   foo = lambda do |x|
+    #     puts "Hello, #{x}"
+    #   end
+    #
+    #   foo = lambda do |x|
+    #     x * 100
+    #   end
+    #
+    # Here, it is impossible to tell from the return value of `lambda` whether
+    # the inner block's return value is significant.
+    - lambda
+    - proc
+    - it

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 adamgeorge.31@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 user_prefs.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 Adam George
+
+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,41 @@
+# UserPrefs
+
+Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/user_prefs`. To experiment with that code, run `bin/console` for an interactive prompt.
+
+TODO: Delete this and the text above, and describe your gem
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'user_prefs'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install user_prefs
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/user_prefs. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://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,3 @@
+require 'bundler/gem_tasks'
+
+task default: :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "user_prefs"
+
+# 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/user_prefs.rb

@@ -0,0 +1,103 @@
+require 'user_prefs/class_methods'
+require 'user_prefs/macro_methods'
+require 'user_prefs/version'
+
+module UserPrefs
+  class ColumnError < StandardError; end
+  class PreferenceError < StandardError; end
+
+  class << self
+    def included(base)
+      validate_column_and_type(base) unless RUBY_ENGINE == :opal
+
+      base.class_eval do
+        class_attribute :defined_prefs, :default_prefs
+
+        self.defined_prefs ||= []
+        self.default_prefs ||= {}
+
+        serialize(prefs_column.to_sym, RUBY_ENGINE == 'opal' ? Hash : HashWithIndifferentAccess)
+      end
+
+      base.extend(ClassMethods)
+    end
+
+    private
+
+    def no_column?(base)
+      !base.columns_hash[base.prefs_column]
+    end
+
+    def name_conflict?(base)
+      base.prefs_column == 'prefs'
+    end
+
+    def wrong_type?(base)
+      base.columns_hash[base.prefs_column] &&
+        base.columns_hash[base.prefs_column].type.to_s != 'text'
+    end
+
+    def validate_column_and_type(base)
+      raise ColumnError, "Preference column name cannot be named 'prefs'." if name_conflict?(base)
+      raise ColumnError, "#{base.name} must have column '#{base.prefs_column}'." if no_column?(base)
+      raise ColumnError, "#{base.prefs_column} must be of type 'text'." if wrong_type?(base)
+    end
+  end
+
+  def prefs
+    prefs_attr.merge(Hash[self.class.defined_prefs.map { |k| [k, send("#{k}_pref")] }])
+  end
+
+  def add_pref(key, value)
+    self.prefs_attr = prefs_attr.merge(Hash[key, value])
+  end
+
+  def delete_pref(key)
+    self.prefs_attr = prefs_attr.reject { |k, _v| k.to_s == key.to_s }
+  end
+
+  def method_missing(method_name, *args, &block)
+    if (match_data = method_name.to_s.match(/(\w+)_pref(=|\?)?/))
+      preference_method(match_data[1], match_data[2], args.first)
+    else
+      super
+    end
+  end
+
+  def respond_to_missing?(method_name, include_private = false)
+    method_name =~ /(\w+)_pref(=|\?)?/ || super
+  end
+
+  private
+
+  def prefs_attr
+    send(self.class.prefs_column)
+  end
+
+  def prefs_attr=(value)
+    send("#{self.class.prefs_column}=", value)
+  end
+
+  def preference_method(key, method = nil, new_value = nil)
+    case method
+    when '?' then prefs_attr.key?(key)
+    when '=' then prefs_attr[key] = new_value
+    else prefs_attr[key]
+    end
+  end
+end
+
+ActiveRecord::Base.class_eval do
+  extend UserPrefs::MacroMethods
+end
+
+unless RUBY_ENGINE == 'opal'
+  # Now if we are NOT running inside of opal, set things up so opal can find
+  # the files. The whole thing is rescued in case the opal gem is not available.
+  # This would happen if the gem is being used server side ONLY.
+  begin
+    require 'opal'
+    Opal.append_path File.expand_path('..', __FILE__).untaint
+  rescue LoadError # rubocop:disable Lint/HandleExceptions
+  end
+end

data/lib/user_prefs/class_methods.rb

@@ -0,0 +1,29 @@
+module UserPrefs
+  module ClassMethods
+    def preference(name = nil, opts = {})
+      validate_name(name)
+
+      defined_prefs << name
+      default_prefs[name.to_s] ||= opts[:default]
+
+      define_method("#{name}_pref") do
+        prefs_attr[name] || opts[:default]
+      end
+
+      define_method("#{name}_pref=") do |new_value|
+        self.prefs_attr = prefs_attr.merge(Hash[name, new_value])
+      end
+
+      define_method("#{name}_pref?") do
+        prefs_attr.key?(name)
+      end
+    end
+
+    private
+
+    def validate_name(name)
+      raise PreferenceError, 'Preference name must be specified.' unless name
+      raise PreferenceError, "#{name} has already been specified." if defined_prefs.include?(name)
+    end
+  end
+end

data/lib/user_prefs/macro_methods.rb

@@ -0,0 +1,11 @@
+module UserPrefs
+  module MacroMethods
+    # I think this is a good name for the macro, but Rubocop disagrees...
+    def has_preferences(column_name = 'preferences') # rubocop:disable Style/PredicateName
+      class_attribute :prefs_column
+
+      self.prefs_column = column_name.to_s
+      include UserPrefs
+    end
+  end
+end

data/lib/user_prefs/version.rb

@@ -0,0 +1,3 @@
+module UserPrefs
+  VERSION = '0.1.0'
+end

data/user_prefs.gemspec

@@ -0,0 +1,28 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'user_prefs/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'user_prefs'
+  spec.version       = UserPrefs::VERSION
+  spec.authors       = ['Adam George']
+  spec.email         = ['adamgeorge.31@gmail.com']
+
+  spec.summary       = 'Quick and easy model preferences for Rails.'
+  spec.description   =
+    'Add preferences to any Rails model easily by adding a text column and adding a couple macros'
+  spec.homepage      = 'https://github.com/adamcreekroad/user_prefs'
+  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_development_dependency 'bundler', '~> 1.12'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'rubocop'
+  spec.add_development_dependency 'rspec'
+end

metadata

@@ -0,0 +1,115 @@
+--- !ruby/object:Gem::Specification
+name: user_prefs
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Adam George
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2016-10-17 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.12'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.12'
+- !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: 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: 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'
+description: Add preferences to any Rails model easily by adding a text column and
+  adding a couple macros
+email:
+- adamgeorge.31@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rubocop.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/user_prefs.rb
+- lib/user_prefs/class_methods.rb
+- lib/user_prefs/macro_methods.rb
+- lib/user_prefs/version.rb
+- user_prefs.gemspec
+homepage: https://github.com/adamcreekroad/user_prefs
+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.5.1
+signing_key: 
+specification_version: 4
+summary: Quick and easy model preferences for Rails.
+test_files: []