axle_attributes 1.13.2

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: d25fdf60b1d16bd313d249594d4347b277dd304e
+  data.tar.gz: 5bb4786bc0b1e5ad172fbaf743077fabd08d4fc1
+SHA512:
+  metadata.gz: 23b04c254bbc1003e231301531ea18e78a89d3b8986391927fe79abb037b2c53282aefa4e2a9370502502d53bc9f4b349b1c6bca9e22b33e17c880dfe8d07160
+  data.tar.gz: a7d1c499bda8c070077a5318493ad16f731dd300eff0aa8595e487fa9ccc96fb958c2921b3fe211320d499e6d1266a1da4cf605a5168e864e0f954f555b9ec37

data/.gitignore

@@ -0,0 +1,4 @@
+Gemfile.lock
+log/*.log
+test/dummy/log/*.log
+test/dummy/tmp

data/.travis.yml

@@ -0,0 +1,16 @@
+language: ruby
+rvm: 2.2.2
+sudo: false
+cache: bundler
+addons:
+  postgresql: '9.4'
+env:
+  global:
+    secure: KODrG44n8gXbtBJc+8U2KtMsVlG/SLgddpR2AquKbYI/ZKe1xsTkb79Qdnh1jBVWdVcUb1DCbxnPH7dt9aoAsiqwZdqc9Tz87EAFv3vM0EnGITBUWM5glsohBriE1+c8kZRh/9ciH4c+SvnwyJKQe/ON9I+He6o+luyZVxvBEQg=
+
+before_script:
+- bundle exec rake app:db:setup
+
+after_success:
+- if [[ -n "$TRAVIS_TAG" ]]; then export GEM_FILENAME=$(gem build axle_attributes.gemspec | grep File | awk '{print $2}'); fi
+- if [[ -n "$TRAVIS_TAG" ]]; then curl -F package=@$GEM_FILENAME $GEMFURY_REPO; fi

data/Gemfile

@@ -0,0 +1,15 @@
+gemspec
+
+gem 'superstore', github: 'data-axle/superstore'
+
+source 'http://rubygems.org' do
+  group :test do
+    gem 'rake'
+    gem 'pg'
+    gem 'factory_girl'
+  end
+end
+
+source 'https://Wp3MVhqmqjJmqddBEsSG@repo.fury.io/dataaxle' do
+  gem 'axle_traveller'
+end

data/README.md

@@ -0,0 +1,10 @@
+### Installation ###
+```
+rake axle_attributes_engine:install:migrations
+```
+
+### Running tests ###
+```
+rake db:create
+rake
+```

data/Rakefile

@@ -0,0 +1,18 @@
+require 'bundler/setup'
+
+APP_RAKEFILE = File.expand_path("../test/dummy/Rakefile", __FILE__)
+load 'rails/tasks/engine.rake'
+
+Bundler::GemHelper.install_tasks
+
+desc 'Default: run unit tests.'
+task default: :test
+
+require 'rake/testtask'
+desc 'Test.'
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'lib'
+  t.libs << 'test'
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = true
+end

data/app/models/attribute_customization.rb

@@ -0,0 +1,7 @@
+class AttributeCustomization < ActiveRecord::Base
+  include AttributeCustomization::LocalCache
+
+  def aliases
+    self.aliases_csv.try(:split, ',') || []
+  end
+end

data/app/models/attribute_customization/local_cache.rb

@@ -0,0 +1,28 @@
+class AttributeCustomization
+  module LocalCache
+    class NamespaceCache < Struct.new(:namespace)
+      include Traveller::LocalCache
+
+      def fetch_value
+        AttributeCustomization.where(namespace: namespace).index_by(&:name)
+      end
+
+      def cache_name
+        "attribute_customizations_#{namespace}"
+      end
+    end
+
+    extend ActiveSupport::Concern
+
+    included do
+      after_save { self.class.namespace_cache_for(namespace).expire! }
+      after_destroy { self.class.namespace_cache_for(namespace).expire! }
+    end
+
+    module ClassMethods
+      def namespace_cache_for(namespace)
+        (@namespace_cache ||= {})[namespace] ||= NamespaceCache.new(namespace)
+      end
+    end
+  end
+end

data/app/models/attribute_mapping.rb

@@ -0,0 +1,15 @@
+class AttributeMapping < ActiveRecord::Base
+  include AttributeMapping::LocalCache
+
+  def definition
+    target_class.attributes[attribute_name]
+  end
+
+  def target_class
+    @target_class ||= namespace.constantize
+  end
+
+  def to_option
+    [label, value]
+  end
+end

data/app/models/attribute_mapping/local_cache.rb

@@ -0,0 +1,40 @@
+class AttributeMapping
+  module LocalCache
+    class MappingCache < Struct.new(:namespace)
+      include Traveller::LocalCache
+
+      def fetch_value
+        sql = %{
+          SELECT attribute_name, value, label
+          FROM attribute_mappings
+          WHERE namespace = #{AttributeMapping.connection.quote(namespace)}
+          ORDER BY value;
+        }.squish!
+
+        AttributeMapping.connection.select_rows(sql).each_with_object({}) do |a, result|
+          name, value, label = a
+          result[name] ||= {}
+          result[name][value] = label
+        end
+      end
+
+      def cache_name
+        "attribute_mapping_#{namespace}"
+      end
+    end
+
+    extend ActiveSupport::Concern
+
+    included do
+      after_save { self.class.cached_mapping_for(namespace).expire! }
+      after_destroy { self.class.cached_mapping_for(namespace).expire! }
+    end
+
+    module ClassMethods
+      def cached_mapping_for(namespace)
+        @cached_mappings ||= {}
+        @cached_mappings[namespace] ||= MappingCache.new(namespace)
+      end
+    end
+  end
+end

data/axle_attributes.gemspec

@@ -0,0 +1,22 @@
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = 'axle_attributes'
+  s.version     = "1.13.2"
+  s.summary     = 'Attribute framework for Data Axle'
+  s.description = 'Why'
+
+  s.required_ruby_version     = '>= 2.0.0'
+  s.required_rubygems_version = '>= 1.8.0'
+
+  s.author            = 'Matthew Higgins'
+  s.email             = 'developer@matthewhiggins.com'
+  s.homepage          = 'http://github.com/data-axle/axle_attributes'
+
+  s.files = `git ls-files`.split("\n")
+
+  s.add_dependency "rails", ">= 4.0"
+  s.add_dependency 'elastic_record'
+  s.add_dependency 'axle_traveller'
+  s.add_dependency 'superstore', '>= 1.0.10'
+end

data/bin/rails

@@ -0,0 +1,8 @@
+#!/usr/bin/env ruby
+# This command will automatically be run when you run "rails" with Rails 4 gems installed from the root of your application.
+
+ENGINE_ROOT = File.expand_path('../..', __FILE__)
+ENGINE_PATH = File.expand_path('../../lib/axle_attributes/engine', __FILE__)
+
+require 'rails/all'
+require 'rails/engine/commands'

data/db/migrate/20131118042651_create_attribute_customizations.rb

@@ -0,0 +1,16 @@
+class CreateAttributeCustomizations < ActiveRecord::Migration
+  def change
+    create_table :attribute_customizations do |t|
+      t.string    :namespace, null: false
+      t.string    :name,      null: false
+      t.text      :aliases_csv
+      t.date      :deprecated_on
+      t.string    :display_name
+      t.text      :description
+      t.string    :instructions
+      t.text      :notes
+      t.index     [:namespace, :name], unique: true
+      t.timestamps
+    end
+  end
+end

data/db/migrate/20131121013237_create_attribute_mappings.rb

@@ -0,0 +1,17 @@
+class CreateAttributeMappings < ActiveRecord::Migration
+  def change
+    create_table :attribute_mappings do |t|
+      t.string :label
+      t.string :value
+      t.string :attribute_name, null: false
+      t.string :namespace,      null: false
+      t.string :default       # ?
+      t.integer :mapped_value # ?
+      t.float   :fill_rate    # ?
+      t.string  :status       # ?
+      t.timestamps
+
+      t.index [:namespace, :attribute_name, :value], name: 'index_attribute_mappings'
+    end
+  end
+end

data/db/migrate/20151120160522_add_editable_to_attribute_customizations.rb

@@ -0,0 +1,7 @@
+class AddEditableToAttributeCustomizations < ActiveRecord::Migration
+  def change
+    change_table :attribute_customizations do |t|
+      t.boolean :editable, null: false, default: true
+    end
+  end
+end

data/lib/axle_attributes.rb

@@ -0,0 +1,30 @@
+require 'active_support/dependencies/autoload'
+require 'active_support/concern'
+
+require 'active_model'
+require 'elastic_record'
+require 'superstore'
+require 'axle_traveller'
+
+require 'axle_attributes/engine'
+
+module AxleAttributes
+  extend ActiveSupport::Autoload
+
+  autoload :ChildDefinition
+  autoload :Conversions
+  autoload :Definition
+  autoload :Dumper
+  autoload :Format
+  autoload :HasAttributes
+  autoload :Model
+  autoload :NullDefinition
+  autoload :ParentDefinition
+  autoload :Provided
+  autoload :Regex
+  autoload :Segmented
+  autoload :Serializations
+  autoload :SerializedChild
+  autoload :Validations
+  autoload :Versioned
+end

data/lib/axle_attributes/child_definition.rb

@@ -0,0 +1,42 @@
+module AxleAttributes
+  class ChildDefinition < ::AxleAttributes::Definition
+    attr_accessor :nested_path
+
+    setup do
+      setup_storage! unless name == 'id'
+      setup_versioning!
+    end
+
+    def display_name
+      human = model.model_name.human
+      human = human.pluralize if nested_path
+      "#{human}: #{super}"
+    end
+
+    def canonical_name
+      @canonical_name ||= "#{model.model_name.send(nested_path ? :plural : :singular)}.#{name}"
+    end
+
+    private
+
+      def setup_storage!
+        if type
+          storage_options = case type
+            when :text
+              {type: :string}
+            else
+              options.slice(:type, :default)
+            end
+
+          model.attribute(name, storage_options)
+        end
+      end
+
+      def setup_versioning!
+        if versioned?
+          model.add_versioned_attribute name
+        end
+      end
+
+  end
+end

data/lib/axle_attributes/conversions.rb

@@ -0,0 +1,36 @@
+module AxleAttributes
+  module Conversions
+    def self.included(base)
+      if base.is_a? Class
+        base.class_eval do
+          cattr_accessor :target_class
+          def self.use_target_class(target_class)
+            self.target_class = target_class
+          end
+        end
+      else
+        base.class_eval do
+          mattr_accessor :target_class
+          def self.use_target_class(target_class)
+            self.target_class = target_class
+          end
+        end
+      end
+    end
+
+    class ConversionError < RuntimeError; end
+
+    module_function
+
+    def to_definition(*args)
+      case args.first
+      when AxleAttributes::Definition
+        args.first
+      when String
+        target_class.attributes[args.first] || AxleAttributes::NullDefinition.new(target_class, args.first)
+      else
+        raise ConversionError.new "Can't convert #{args}.inspect to Field"
+      end
+    end
+  end
+end

data/lib/axle_attributes/definition.rb

@@ -0,0 +1,118 @@
+require 'axle_attributes/definition/callbacks'
+require 'axle_attributes/definition/customization'
+require 'axle_attributes/definition/formatted'
+require 'axle_attributes/definition/indexed'
+require 'axle_attributes/definition/mappings'
+
+module AxleAttributes
+  class Definition
+    include AxleAttributes::Definition::Callbacks
+
+    include AxleAttributes::Definition::Indexed
+    include AxleAttributes::Definition::Mappings
+    include AxleAttributes::Definition::Formatted
+    include AxleAttributes::Definition::Customization
+
+    attr_accessor :model, :name, :options
+    delegate :description, to: :customization, allow_nil: true
+
+    def initialize(model, name, options = {})
+      @model = model
+      @name = name.to_s
+      @options = options
+    end
+
+    class << self
+      def reset_caches
+        cached_customizations.clear
+        cached_attribute_mappings.clear
+      end
+    end
+
+    def setup!
+      run_callbacks :setup
+    end
+
+    def canonical_name
+      name
+    end
+
+    FILTER_CONTROL_DEFAULTS = {
+      float:    'range',
+      integer:  'range',
+      string:   'text',
+      text:     'text',
+      boolean:  'radio',
+      time:     'daterange'
+    }
+    def filter_control
+      if mapping_model
+        mapping_model.respond_to?(:code_hierarchy_lengths) ? 'hierarchy' : 'combo'
+      elsif mappings.any?
+        'checkbox'
+      else
+        FILTER_CONTROL_DEFAULTS.fetch(type, 'text')
+      end
+    end
+
+    EDIT_CONTROL_DEFAULTS = {
+      float:    'text',
+      integer:  'text',
+      text:     'textarea',
+      string:   'text',
+      time:     'filter',
+      boolean:  'combo',
+    }
+    def edit_control
+      if mappings.any?
+        'combo'
+      else
+        EDIT_CONTROL_DEFAULTS[type]
+      end
+    end
+
+    def aliases
+      result = [name, display_name, options[:mmdb_name], customization.try(:aliases)]
+      result.flatten!
+      result.compact!
+      result
+    end
+
+    def to_param
+      name
+    end
+
+    def namespace
+      model.name
+    end
+
+    def type
+      options[:type]
+    end
+
+    def format
+      options[:format]
+    end
+
+    def readonly?
+      !editable?
+    end
+
+    def editable?
+      editable_customization && !deprecated? && options.fetch(:editable, true)
+    end
+
+    def indexed?
+      options[:index]
+    end
+
+    def versioned?
+      options[:version]
+    end
+
+    def default
+      options[:default]
+    end
+
+  end
+end