rails-properties 3.4.3

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 7be3c5bb1390b030f3cf3b0bd14a0b7227806704
+  data.tar.gz: bf1b88871e3f28897b72a33e305d329ea2041e4e
+SHA512:
+  metadata.gz: a9f6063f9fd8e8f0b68b8f3bb5b4d1c82cd6551e856d52b05e5a42f45a1a965d25f52942226cb528fb0aef9d50b8ac81af11daf5e5c311fb7ad01997cde81dc5
+  data.tar.gz: 41c8f6000e5ab99749548fac88738720a69c86a83241ef43386e2f2183a706eaa84507c9941dddcaeed5d92d71d7c77cb6aaf5ae58e99449527822cb37026594

data/.gitignore

@@ -0,0 +1,5 @@
+*.gem
+.bundle
+Gemfile.lock
+pkg/*
+coverage/*

data/.travis.yml

@@ -0,0 +1,74 @@
+language: ruby
+rvm:
+  - 1.9.3
+  - 2.0.0
+  - 2.1.10
+  - 2.2.9
+  - 2.3.6
+  - 2.4.3
+  - 2.5.0
+gemfile:
+  - ci/Gemfile-rails-3-1
+  - ci/Gemfile-rails-3-2
+  - ci/Gemfile-rails-4-0
+  - ci/Gemfile-rails-4-1
+  - ci/Gemfile-rails-4-2
+  - ci/Gemfile-rails-5-0
+  - ci/Gemfile-rails-5-1
+  - ci/Gemfile-rails-5-2
+matrix:
+  include:
+    - rvm: 2.2.9
+      gemfile: ci/Gemfile-rails-4-0
+      env: PROTECTED_ATTRIBUTES=true
+    - rvm: 2.2.9
+      gemfile: ci/Gemfile-rails-4-1
+      env: PROTECTED_ATTRIBUTES=true
+    - rvm: 2.2.9
+      gemfile: ci/Gemfile-rails-4-2
+      env: PROTECTED_ATTRIBUTES=true
+  exclude:
+    - rvm: 1.9.3
+      gemfile: ci/Gemfile-rails-5-0
+    - rvm: 1.9.3
+      gemfile: ci/Gemfile-rails-5-1
+    - rvm: 1.9.3
+      gemfile: ci/Gemfile-rails-5-2
+    - rvm: 2.0.0
+      gemfile: ci/Gemfile-rails-5-0
+    - rvm: 2.0.0
+      gemfile: ci/Gemfile-rails-5-1
+    - rvm: 2.0.0
+      gemfile: ci/Gemfile-rails-5-2
+    - rvm: 2.1.10
+      gemfile: ci/Gemfile-rails-5-0
+    - rvm: 2.1.10
+      gemfile: ci/Gemfile-rails-5-1
+    - rvm: 2.1.10
+      gemfile: ci/Gemfile-rails-5-2
+    - rvm: 2.2.9
+      gemfile: ci/Gemfile-rails-3-1
+    - rvm: 2.3.6
+      gemfile: ci/Gemfile-rails-3-1
+    - rvm: 2.4.3
+      gemfile: ci/Gemfile-rails-3-1
+    - rvm: 2.5.0
+      gemfile: ci/Gemfile-rails-3-1
+    - rvm: 2.2.9
+      gemfile: ci/Gemfile-rails-3-2
+    - rvm: 2.3.6
+      gemfile: ci/Gemfile-rails-3-2
+    - rvm: 2.4.3
+      gemfile: ci/Gemfile-rails-3-2
+    - rvm: 2.4.3
+      gemfile: ci/Gemfile-rails-4-0
+    - rvm: 2.4.3
+      gemfile: ci/Gemfile-rails-4-1
+    - rvm: 2.5.0
+      gemfile: ci/Gemfile-rails-3-2
+    - rvm: 2.5.0
+      gemfile: ci/Gemfile-rails-4-0
+    - rvm: 2.5.0
+      gemfile: ci/Gemfile-rails-4-1
+before_install: gem update bundler
+sudo: false

data/Gemfile

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

data/MIT-LICENSE

@@ -0,0 +1,22 @@
+Copyright (c) 2012-2018 Georg Ledermann
+
+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,135 @@
+# Properties for Rails
+
+Ruby gem to handle properties for ActiveRecord instances by storing them as serialized Hash in a separate database table. Namespaces and defaults included.
+
+## Requirements
+
+* Ruby 1.9.3 or newer
+* Rails 3.1 or newer (including Rails 5.2)
+
+
+## Installation
+
+Include the gem in your Gemfile and run `bundle` to install it:
+
+```ruby
+gem 'rails-properties'
+```
+
+Generate and run the migration:
+
+```shell
+rails g rails_properties:migration
+rake db:migrate
+```
+
+
+## Usage
+
+### Define properties
+
+```ruby
+class User < ActiveRecord::Base
+  has_properties do |s|
+    s.key :dashboard, :defaults => { :theme => 'blue', :view => 'monthly', :filter => false }
+    s.key :calendar,  :defaults => { :scope => 'company'}
+  end
+end
+```
+
+If no defaults are needed, a simplified syntax can be used:
+
+```ruby
+class User < ActiveRecord::Base
+  has_properties :dashboard, :calendar
+end
+```
+
+Every property is handled by the class `RailsProperties::PropertyObject`. You can use your own class, e.g. for validations:
+
+```ruby
+class Project < ActiveRecord::Base
+  has_properties :info, :class_name => 'ProjectPropertyObject'
+end
+
+class ProjectPropertyObject < RailsProperties::PropertyObject
+  validate do
+    unless self.owner_name.present? && self.owner_name.is_a?(String)
+      errors.add(:base, "Owner name is missing")
+    end
+  end
+end
+```
+
+### Set properties
+
+```ruby
+user = User.find(1)
+user.properties(:dashboard).theme = 'black'
+user.properties(:calendar).scope = 'all'
+user.properties(:calendar).display = 'daily'
+user.save! # saves new or changed properties, too
+```
+
+or
+
+```ruby
+user = User.find(1)
+user.properties(:dashboard).update_attributes! :theme => 'black'
+user.properties(:calendar).update_attributes! :scope => 'all', :display => 'daily'
+```
+
+
+### Get properties
+
+```ruby
+user = User.find(1)
+user.properties(:dashboard).theme
+# => 'black
+
+user.properties(:dashboard).view
+# => 'monthly'  (it's the default)
+
+user.properties(:calendar).scope
+# => 'all'
+```
+
+### Delete properties
+
+```ruby
+user = User.find(1)
+user.properties(:dashboard).update_attributes! :theme => nil
+
+user.properties(:dashboard).view = nil
+user.properties(:dashboard).save!
+```
+
+### Using scopes
+
+```ruby
+User.with_properties
+# => all users having any property
+
+User.without_properties
+# => all users without having any property
+
+User.with_properties_for(:calendar)
+# => all users having a property for 'calender'
+
+User.without_properties_for(:calendar)
+# => all users without having properties for 'calendar'
+```
+
+### Eager Loading
+```ruby
+User.includes(:property_objects)
+# => Eager load property_objects when querying many users
+```
+
+## License
+
+MIT License
+
+Copyright (c) 2012-2018 [Georg Ledermann](http://www.georg-ledermann.de)
+
+This gem is a rename of [rails-settings](https://github.com/ledermann/rails-settings) by [Georg Ledermann](https://github.com/ledermann)

data/Rakefile

@@ -0,0 +1,6 @@
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/ci/Gemfile-rails-3-1

@@ -0,0 +1,5 @@
+source 'https://rubygems.org'
+
+gem 'activerecord', '~> 3.1.12'
+
+gemspec :path => "../"

data/ci/Gemfile-rails-3-2

@@ -0,0 +1,5 @@
+source 'https://rubygems.org'
+
+gem 'activerecord', '~> 3.2.22'
+
+gemspec :path => "../"

data/ci/Gemfile-rails-4-0

@@ -0,0 +1,6 @@
+source 'https://rubygems.org'
+
+gem 'activerecord', '~> 4.0.13'
+gem 'protected_attributes' if ENV['PROTECTED_ATTRIBUTES'] == 'true'
+
+gemspec :path => "../"

data/ci/Gemfile-rails-4-1

@@ -0,0 +1,6 @@
+source 'https://rubygems.org'
+
+gem 'activerecord', '~> 4.1.10'
+gem 'protected_attributes' if ENV['PROTECTED_ATTRIBUTES'] == 'true'
+
+gemspec :path => "../"

data/ci/Gemfile-rails-4-2

@@ -0,0 +1,6 @@
+source 'https://rubygems.org'
+
+gem 'activerecord', '~> 4.2.1'
+gem 'protected_attributes' if ENV['PROTECTED_ATTRIBUTES'] == 'true'
+
+gemspec :path => "../"

data/ci/Gemfile-rails-5-0

@@ -0,0 +1,5 @@
+source 'https://rubygems.org'
+
+gem 'activerecord', '~> 5.0.0'
+
+gemspec :path => "../"

data/ci/Gemfile-rails-5-1

@@ -0,0 +1,5 @@
+source 'https://rubygems.org'
+
+gem 'activerecord', '~> 5.1.0'
+
+gemspec :path => "../"

data/ci/Gemfile-rails-5-2

@@ -0,0 +1,5 @@
+source 'https://rubygems.org'
+
+gem 'activerecord', '~> 5.2.0.rc1'
+
+gemspec :path => "../"

data/lib/generators/rails_properties/migration/migration_generator.rb

@@ -0,0 +1,23 @@
+require 'rails/generators'
+require 'rails/generators/migration'
+
+module RailsProperties
+  class MigrationGenerator < Rails::Generators::Base
+    include Rails::Generators::Migration
+
+    desc "Generates migration for rails-properties"
+    source_root File.expand_path('../templates', __FILE__)
+
+    def create_migration_file
+      migration_template 'migration.rb', 'db/migrate/rails_properties_migration.rb'
+    end
+
+    def self.next_migration_number(dirname)
+      if ActiveRecord::Base.timestamped_migrations
+        Time.now.utc.strftime("%Y%m%d%H%M%S")
+      else
+        "%.3d" % (current_migration_number(dirname) + 1)
+      end
+    end
+  end
+end

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

@@ -0,0 +1,21 @@
+MIGRATION_BASE_CLASS = if ActiveRecord::VERSION::MAJOR >= 5
+  ActiveRecord::Migration[5.0]
+else
+  ActiveRecord::Migration
+end
+
+class RailsPropertiesMigration < MIGRATION_BASE_CLASS
+  def self.up
+    create_table :properties do |t|
+      t.string     :var,    :null => false
+      t.text       :value
+      t.references :target, :null => false, :polymorphic => true
+      t.timestamps :null => true
+    end
+    add_index :properties, [ :target_type, :target_id, :var ], :unique => true
+  end
+
+  def self.down
+    drop_table :properties
+  end
+end

data/lib/rails-properties.rb

@@ -0,0 +1,23 @@
+module RailsProperties
+  # In Rails 3, attributes can be protected by `attr_accessible` and `attr_protected`
+  # In Rails 4, attributes can be protected by using the gem `protected_attributes`
+  # In Rails 5, protecting attributes is obsolete (there are `StrongParameters` only)
+  def self.can_protect_attributes?
+    (ActiveRecord::VERSION::MAJOR == 3) || defined?(ProtectedAttributes)
+  end
+end
+
+require 'rails-properties/property_object'
+require 'rails-properties/configuration'
+require 'rails-properties/base'
+require 'rails-properties/scopes'
+
+ActiveRecord::Base.class_eval do
+  def self.has_properties(*args, &block)
+    RailsProperties::Configuration.new(*args.unshift(self), &block)
+
+    include RailsProperties::Base
+    extend RailsProperties::Scopes
+  end
+end
+

data/lib/rails-properties/base.rb

@@ -0,0 +1,48 @@
+module RailsProperties
+  module Base
+    def self.included(base)
+      base.class_eval do
+        has_many :property_objects,
+                 :as         => :target,
+                 :autosave   => true,
+                 :dependent  => :delete_all,
+                 :class_name => self.property_object_class_name
+
+        def properties(var)
+          raise ArgumentError unless var.is_a?(Symbol)
+          raise ArgumentError.new("Unknown key: #{var}") unless self.class.default_properties[var]
+
+          if RailsProperties.can_protect_attributes?
+            property_objects.detect { |s| s.var == var.to_s } || property_objects.build({ :var => var.to_s }, :without_protection => true)
+          else
+            property_objects.detect { |s| s.var == var.to_s } || property_objects.build(:var => var.to_s, :target => self)
+          end
+        end
+
+        def properties=(value)
+          if value.nil?
+            property_objects.each(&:mark_for_destruction)
+          else
+            raise ArgumentError
+          end
+        end
+
+        def properties?(var=nil)
+          if var.nil?
+            property_objects.any? { |property_object| !property_object.marked_for_destruction? && property_object.value.present? }
+          else
+            properties(var).value.present?
+          end
+        end
+
+        def to_properties_hash
+          properties_hash = self.class.default_properties.dup
+          properties_hash.each do |var, vals|
+            properties_hash[var] = properties_hash[var].merge(properties(var.to_sym).value)
+          end
+          properties_hash
+        end
+      end
+    end
+  end
+end

data/lib/rails-properties/configuration.rb

@@ -0,0 +1,32 @@
+module RailsProperties
+  class Configuration
+    def initialize(*args, &block)
+      options = args.extract_options!
+      klass = args.shift
+      keys = args
+
+      raise ArgumentError unless klass
+
+      @klass = klass
+      @klass.class_attribute :default_properties, :property_object_class_name
+      @klass.default_properties = {}
+      @klass.property_object_class_name = options[:class_name] || 'RailsProperties::PropertyObject'
+
+      if block_given?
+        yield(self)
+      else
+        keys.each do |k|
+          key(k)
+        end
+      end
+
+      raise ArgumentError.new('has_properties: No keys defined') if @klass.default_properties.blank?
+    end
+
+    def key(name, options={})
+      raise ArgumentError.new("has_properties: Symbol expected, but got a #{name.class}") unless name.is_a?(Symbol)
+      raise ArgumentError.new("has_properties: Option :defaults expected, but got #{options.keys.join(', ')}") unless options.blank? || (options.keys == [:defaults])
+      @klass.default_properties[name] = (options[:defaults] || {}).stringify_keys.freeze
+    end
+  end
+end