listable_collections 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: e8963f1810aa2b139c4c449502a8b0df20465c6b
+  data.tar.gz: 39ee8746a56e6f2ddb5957f89d9ed146290d9250
+SHA512:
+  metadata.gz: 719b901eebf02b4bc8c8f68ab72fc865d06809ecb49a0d17653914ef6c67a0229ba0adbcc32c8cb0de7fd33676d1de8d16b7757b67ba9c17b9671b967296a17f
+  data.tar.gz: d89167bcd305e6c0196cca408454d621bf4bcf26bf211b3c6dddf98efb2baf6f369ef4a4a34ed27d68a55b5f8eeda7b097025db354b60315eb25570dc95a34b0

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2016 Mathías Montossi
+
+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,101 @@
+[![Gem Version](https://badge.fury.io/rb/listable_collections.svg)](http://badge.fury.io/rb/listable_collections)
+[![Code Climate](https://codeclimate.com/github/mmontossi/listable_collections/badges/gpa.svg)](https://codeclimate.com/github/mmontossi/listable_collections)
+[![Build Status](https://travis-ci.org/mmontossi/listable_collections.svg)](https://travis-ci.org/mmontossi/listable_collections)
+[![Dependency Status](https://gemnasium.com/mmontossi/listable_collections.svg)](https://gemnasium.com/mmontossi/listable_collections)
+
+# Listable collections
+
+Makes collections accessible from a string list in rails.
+
+## Install
+
+Put this line in your Gemfile:
+```ruby
+gem 'listable_collections'
+```
+
+Then bundle:
+```
+$ bundle
+```
+
+## Usage
+
+Use "list" method in your models to define what collections will be listed:
+
+If you want to list an association:
+```ruby
+class Shop < ActiveRecord::Base
+
+  has_many :products
+
+  list :products, attribute: :name
+
+end
+```
+
+Associated records won't be touched but changes will be tracked using "removed_from_list" and "added_to_list" helpers:
+```ruby
+shop.products.map(&:name) => ['iPhone']
+shop.product_list => 'iPhone'
+
+shop.product_list = 'iPod,iMac'
+shop.products.map(&:name) => ['iPhone']
+
+shop.added_products_to_list => ['iMac']
+shop.removed_products_from_list => ['iPod']
+```
+
+If you want to list an array attribute:
+```ruby
+class Product < ActiveRecord::Base
+
+  serialize :sizes, Array
+
+  list :sizes
+
+end
+```
+
+The attribute will be synced and chances will be tracked using "removed_from_list" and "added_to_list" helpers:
+```ruby
+product.sizes => ['64GB']
+product.size_list => '64GB'
+
+product.size_list = '32GB,128GB'
+product.sizes => ['32GB','128GB']
+
+product.added_sizes_to_list => ['128GB']
+product.removed_sizes_from_list => ['64GB']
+```
+
+In some cases you may need to run some logic after changes, you can use "after_add" and "after_remove" callbacks for it:
+```ruby
+class Shop < ActiveRecord::Base
+
+  has_many :product
+
+  list :products, attribute: :name, after_add: :product_added, after_remove: :product_removed
+
+  def product_added(name)
+    # Some logic
+  end
+
+  def product_removed(name)
+    # Some logic
+  end
+
+end
+```
+
+## Contributing
+
+Because we've limited resources we'll mainly add features and keep a compatibility range close to what we need in our projects. However, contributions are more than welcome if someone wants to make any improvement.
+
+## Credits
+
+This gem is maintained and funded by [mmontossi](https://github.com/mmontossi).
+
+## License
+
+It is free software, and may be redistributed under the terms specified in the MIT-LICENSE file.

data/Rakefile

@@ -0,0 +1,37 @@
+begin
+  require 'bundler/setup'
+rescue LoadError
+  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+end
+
+require 'rdoc/task'
+
+RDoc::Task.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'ListableCollections'
+  rdoc.options << '--line-numbers'
+  rdoc.rdoc_files.include('README.rdoc')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+
+
+
+
+
+Bundler::GemHelper.install_tasks
+
+APP_RAKEFILE = File.expand_path('../test/dummy/Rakefile', __FILE__)
+load 'rails/tasks/engine.rake'
+
+require 'rake/testtask'
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'lib'
+  t.libs << 'test'
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = false
+end
+
+
+task default: :test

data/lib/listable_collections/builder.rb

@@ -0,0 +1,91 @@
+module ListableCollections
+  class Builder
+
+    attr_reader :model
+
+    def initialize(model)
+      @model = model
+    end
+
+    def define(attribute, options)
+      plural = (options[:as] || attribute).to_s
+      singular = plural.singularize
+      name = "#{singular}_list"
+      variable = "@#{name}"
+      was = "#{name}_was"
+      if Rails::VERSION::MAJOR == 4 && Rails::VERSION::MINOR < 2
+        model.skip_time_zone_conversion_for_attributes << name.to_sym
+      end
+      model.define_attribute_method name
+      define_list_writer name, variable, attribute, options
+      define_list_reader name, variable, attribute, options
+      define_added_to_list_reader plural, name, was
+      define_removed_from_list_reader plural, name, was
+    end
+
+    private
+
+    def define_list_writer(name, variable, attribute, options)
+      model.class_eval do
+        define_method "#{name}=" do |value|
+          current_values = send(name).split(',')
+          new_values = value.split(',').reject(&:blank?).map(&:strip)
+          value = ((current_values & new_values) + (new_values - current_values))
+          if current_values.sort != new_values.sort
+            if options.has_key?(:attribute)
+              attribute_will_change! name
+              instance_variable_set variable, value.join(',')
+            else
+              attribute_will_change! name
+              send "#{attribute}=", value
+            end
+            if options.has_key?(:after_add)
+              (new_values - current_values).each do |added_value|
+                send options[:after_add], added_value
+              end
+            end
+            if options.has_key?(:after_remove)
+              (current_values - new_values).each do |removed_value|
+                send options[:after_remove], removed_value
+              end
+            end
+          end
+        end
+      end
+    end
+
+    def define_list_reader(name, variable, attribute, options)
+      model.class_eval do
+        define_method name do
+          if list = instance_variable_get(variable)
+            list
+          elsif values = send(attribute)
+            if options.has_key?(:attribute)
+              values = values.map do |record|
+                record.send options[:attribute]
+              end
+            end
+            values.join(',')
+          end
+        end
+      end
+    end
+
+    def define_added_to_list_reader(plural, name, was)
+      model.class_eval do
+        define_method "added_#{plural}_to_list" do
+          send(name).split(',') - send(was).split(',')
+        end
+      end
+    end
+
+    def define_removed_from_list_reader(plural, name, was)
+      model.class_eval do
+        define_method "removed_#{plural}_from_list" do
+          send(was).split(',') - send(name).split(',')
+        end
+      end
+    end
+
+  end
+end

data/lib/listable_collections/extensions/active_record/base.rb

@@ -0,0 +1,21 @@
+module ListableCollections
+  module Extensions
+    module ActiveRecord
+      module Base
+        extend ActiveSupport::Concern
+
+        module ClassMethods
+
+          def list(*args)
+            options = args.extract_options!
+            builder = Builder.new(self)
+            args.each do |attribute|
+              builder.define attribute, options
+            end
+          end
+
+        end
+      end
+    end
+  end
+end

data/lib/listable_collections/railtie.rb

@@ -0,0 +1,9 @@
+module ListableCollections
+  class Railtie < Rails::Railtie
+
+    initializer :listable_collections do
+      ::ActiveRecord::Base.include Extensions::ActiveRecord::Base
+    end
+
+  end
+end

data/lib/listable_collections/version.rb

@@ -0,0 +1,3 @@
+module ListableCollections
+  VERSION = '0.0.1'
+end

data/lib/listable_collections.rb

@@ -0,0 +1,6 @@
+require 'listable_collections/builder'
+require 'listable_collections/extensions/active_record/base'
+require 'listable_collections/railtie'
+
+module ListableCollections
+end

data/test/association_test.rb

@@ -0,0 +1,25 @@
+require 'test_helper'
+
+class AssociationTest < ActiveSupport::TestCase
+
+  test 'accessor' do
+    apple = shops(:apple)
+    assert_equal 'iPhone,iPad', apple.product_list
+
+    imac = Product.new(name: 'iMac')
+    apple.expects(:product_added).never
+    apple.expects(:product_removed).never
+    apple.products << imac
+    assert_equal 'iPhone,iPad,iMac', apple.product_list
+    assert_equal [], apple.added_products_to_list
+    assert_equal [], apple.removed_products_from_list
+
+    apple.expects(:product_added).once.with('MacBook')
+    apple.expects(:product_removed).once.with('iPad')
+    apple.product_list = 'iMac,iPhone,MacBook'
+    assert_equal 'iPhone,iMac,MacBook', apple.product_list
+    assert_equal ['MacBook'], apple.added_products_to_list
+    assert_equal ['iPad'], apple.removed_products_from_list
+  end
+
+end

data/test/attribute_test.rb

@@ -0,0 +1,24 @@
+require 'test_helper'
+
+class AttributeTest < ActiveSupport::TestCase
+
+  test 'accessor' do
+    iphone = products(:iphone)
+    assert_equal '', iphone.size_list
+
+    iphone.expects(:size_added).never
+    iphone.expects(:size_removed).never
+    iphone.sizes << '64GB'
+    assert_equal '64GB', iphone.size_list
+    assert_equal [], iphone.added_sizes_to_list
+    assert_equal [], iphone.removed_sizes_from_list
+
+    iphone.expects(:size_added).once.with('32GB')
+    iphone.expects(:size_removed).once.with('64GB')
+    iphone.size_list = '32GB'
+    assert_equal '32GB', iphone.size_list
+    assert_equal ['32GB'], iphone.added_sizes_to_list
+    assert_equal ['64GB'], iphone.removed_sizes_from_list
+  end
+
+end

data/test/dummy/README.rdoc

@@ -0,0 +1,28 @@
+== README
+
+This README would normally document whatever steps are necessary to get the
+application up and running.
+
+Things you may want to cover:
+
+* Ruby version
+
+* System dependencies
+
+* Configuration
+
+* Database creation
+
+* Database initialization
+
+* How to run the test suite
+
+* Services (job queues, cache servers, search engines, etc.)
+
+* Deployment instructions
+
+* ...
+
+
+Please feel free to use a different markup language if you do not plan to run
+<tt>rake doc:app</tt>.

data/test/dummy/Rakefile

@@ -0,0 +1,6 @@
+# Add your own tasks in files placed in lib/tasks ending in .rake,
+# for example lib/tasks/capistrano.rake, and they will automatically be available to Rake.
+
+require File.expand_path('../config/application', __FILE__)
+
+Rails.application.load_tasks

data/test/dummy/app/assets/javascripts/application.js

@@ -0,0 +1,13 @@
+// This is a manifest file that'll be compiled into application.js, which will include all the files
+// listed below.
+//
+// Any JavaScript/Coffee file within this directory, lib/assets/javascripts, vendor/assets/javascripts,
+// or any plugin's vendor/assets/javascripts directory can be referenced here using a relative path.
+//
+// It's not advisable to add code directly here, but if you do, it'll appear at the bottom of the
+// compiled file.
+//
+// Read Sprockets README (https://github.com/rails/sprockets#sprockets-directives) for details
+// about supported directives.
+//
+//= require_tree .

data/test/dummy/app/assets/stylesheets/application.css

@@ -0,0 +1,15 @@
+/*
+ * This is a manifest file that'll be compiled into application.css, which will include all the files
+ * listed below.
+ *
+ * Any CSS and SCSS file within this directory, lib/assets/stylesheets, vendor/assets/stylesheets,
+ * or any plugin's vendor/assets/stylesheets directory can be referenced here using a relative path.
+ *
+ * You're free to add application-wide styles to this file and they'll appear at the bottom of the
+ * compiled file so the styles you add here take precedence over styles defined in any styles
+ * defined in the other CSS/SCSS files in this directory. It is generally better to create a new
+ * file per style scope.
+ *
+ *= require_tree .
+ *= require_self
+ */

data/test/dummy/app/controllers/application_controller.rb

@@ -0,0 +1,5 @@
+class ApplicationController < ActionController::Base
+  # Prevent CSRF attacks by raising an exception.
+  # For APIs, you may want to use :null_session instead.
+  protect_from_forgery with: :exception
+end

data/test/dummy/app/helpers/application_helper.rb

@@ -0,0 +1,2 @@
+module ApplicationHelper
+end

data/test/dummy/app/models/product.rb

@@ -0,0 +1,15 @@
+class Product < ActiveRecord::Base
+
+  belongs_to :shop
+
+  list :sizes, after_add: :size_added, after_remove: :size_removed
+
+  serialize :sizes, Array
+
+  def size_added(size)
+  end
+
+  def size_removed(size)
+  end
+
+end

data/test/dummy/app/models/shop.rb

@@ -0,0 +1,13 @@
+class Shop < ActiveRecord::Base
+
+  has_many :products
+
+  list :products, attribute: :name, after_add: :product_added, after_remove: :product_removed
+
+  def product_added(product)
+  end
+
+  def product_removed(product)
+  end
+
+end

data/test/dummy/app/views/layouts/application.html.erb

@@ -0,0 +1,14 @@
+<!DOCTYPE html>
+<html>
+<head>
+  <title>Dummy</title>
+  <%= stylesheet_link_tag    'application', media: 'all', 'data-turbolinks-track' => true %>
+  <%= javascript_include_tag 'application', 'data-turbolinks-track' => true %>
+  <%= csrf_meta_tags %>
+</head>
+<body>
+
+<%= yield %>
+
+</body>
+</html>

data/test/dummy/bin/bundle

@@ -0,0 +1,3 @@
+#!/usr/bin/env ruby
+ENV['BUNDLE_GEMFILE'] ||= File.expand_path('../../Gemfile', __FILE__)
+load Gem.bin_path('bundler', 'bundle')

data/test/dummy/bin/rails

@@ -0,0 +1,4 @@
+#!/usr/bin/env ruby
+APP_PATH = File.expand_path('../../config/application', __FILE__)
+require_relative '../config/boot'
+require 'rails/commands'

data/test/dummy/bin/rake

@@ -0,0 +1,4 @@
+#!/usr/bin/env ruby
+require_relative '../config/boot'
+require 'rake'
+Rake.application.run

data/test/dummy/bin/setup

@@ -0,0 +1,29 @@
+#!/usr/bin/env ruby
+require 'pathname'
+
+# path to your application root.
+APP_ROOT = Pathname.new File.expand_path('../../',  __FILE__)
+
+Dir.chdir APP_ROOT do
+  # This script is a starting point to setup your application.
+  # Add necessary setup steps to this file:
+
+  puts '== Installing dependencies =='
+  system 'gem install bundler --conservative'
+  system 'bundle check || bundle install'
+
+  # puts "\n== Copying sample files =="
+  # unless File.exist?('config/database.yml')
+  #   system 'cp config/database.yml.sample config/database.yml'
+  # end
+
+  puts "\n== Preparing database =="
+  system 'bin/rake db:setup'
+
+  puts "\n== Removing old logs and tempfiles =="
+  system 'rm -f log/*'
+  system 'rm -rf tmp/cache'
+
+  puts "\n== Restarting application server =="
+  system 'touch tmp/restart.txt'
+end

data/test/dummy/config/application.rb

@@ -0,0 +1,27 @@
+require File.expand_path('../boot', __FILE__)
+
+require 'rails/all'
+
+Bundler.require(*Rails.groups)
+require 'listable_collections'
+
+module Dummy
+  class Application < Rails::Application
+    # Settings in config/environments/* take precedence over those specified here.
+    # Application configuration should go into files in config/initializers
+    # -- all .rb files in that directory are automatically loaded.
+
+    # Set Time.zone default to the specified zone and make Active Record auto-convert to this zone.
+    # Run "rake -D time" for a list of tasks for finding time zone names. Default is UTC.
+    # config.time_zone = 'Central Time (US & Canada)'
+
+    # The default locale is :en and all translations from config/locales/*.rb,yml are auto loaded.
+    # config.i18n.load_path += Dir[Rails.root.join('my', 'locales', '*.{rb,yml}').to_s]
+    # config.i18n.default_locale = :de
+
+    if Rails::VERSION::MAJOR == 4 && Rails::VERSION::MINOR >= 2
+      # Do not swallow errors in after_commit/after_rollback callbacks.
+      config.active_record.raise_in_transactional_callbacks = true
+    end
+  end
+end

data/test/dummy/config/boot.rb

@@ -0,0 +1,5 @@
+# Set up gems listed in the Gemfile.
+ENV['BUNDLE_GEMFILE'] ||= File.expand_path('../../../../Gemfile', __FILE__)
+
+require 'bundler/setup' if File.exist?(ENV['BUNDLE_GEMFILE'])
+$LOAD_PATH.unshift File.expand_path('../../../../lib', __FILE__)

data/test/dummy/config/database.yml

@@ -0,0 +1,10 @@
+default: &default
+  adapter: postgresql
+
+development:
+  <<: *default
+  database: listable_collections_development
+
+test:
+  <<: *default
+  database: listable_collections_test

data/test/dummy/config/database.yml.travis

@@ -0,0 +1,19 @@
+mysql: &mysql
+  adapter: <%= 'jdbc' if RUBY_ENGINE == 'jruby' %>mysql<%= '2' if RUBY_ENGINE != 'jruby' %>
+
+postgres: &postgres
+  adapter: <%= 'jdbc' if RUBY_ENGINE == 'jruby' %>postgresql
+
+sqlite: &sqlite
+  adapter: <%= 'jdbc' if RUBY_ENGINE == 'jruby' %>sqlite3
+
+default: &default
+  <<: *<%= ENV['DB'] %>
+
+development:
+  <<: *default
+  database: travis
+
+test:
+  <<: *default
+  database: travis

data/test/dummy/config/environment.rb

@@ -0,0 +1,5 @@
+# Load the Rails application.
+require File.expand_path('../application', __FILE__)
+
+# Initialize the Rails application.
+Rails.application.initialize!

data/test/dummy/config/environments/development.rb

@@ -0,0 +1,41 @@
+Dummy::Application.configure do
+  # Settings specified here will take precedence over those in config/application.rb.
+
+  # In the development environment your application's code is reloaded on
+  # every request. This slows down response time but is perfect for development
+  # since you don't have to restart the web server when you make code changes.
+  config.cache_classes = false
+
+  # Do not eager load code on boot.
+  config.eager_load = false
+
+  # Show full error reports and disable caching.
+  config.consider_all_requests_local = true
+  config.action_controller.perform_caching = false
+
+  # Don't care if the mailer can't send.
+  config.action_mailer.raise_delivery_errors = false
+
+  # Print deprecation notices to the Rails logger.
+  config.active_support.deprecation = :log
+
+  # Raise an error on page load if there are pending migrations.
+  config.active_record.migration_error = :page_load
+
+  # Debug mode disables concatenation and preprocessing of assets.
+  # This option may cause significant delays in view rendering with a large
+  # number of complex assets.
+  config.assets.debug = true
+
+  # Asset digests allow you to set far-future HTTP expiration dates on all assets,
+  # yet still be able to expire them through the digest params.
+  config.assets.digest = true
+
+  # Adds additional error checking when serving assets at runtime.
+  # Checks for improperly declared sprockets dependencies.
+  # Raises helpful error messages.
+  config.assets.raise_runtime_errors = true
+
+  # Raises error for missing translations
+  # config.action_view.raise_on_missing_translations = true
+end