templatr 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 32041fe62ad050adc8cf4e9f0597cb11860a97f3
+  data.tar.gz: c563d911b5beec9fb6ac262a327cc22ea5e1c2de
+SHA512:
+  metadata.gz: becc08187da3c2adff63e823e26667659506928e9305ce0a1b50185183624e9337a72ba6be4184bfacbdd0810cc6c8b376a4277c37bcb34de509a9cf1f0f631d
+  data.tar.gz: f6d84d360119094beeba9ded075ce15ba5128403df732dfe69d6f88bf151bfa33aca8cd5878e632a3bb2552794315f7e7f564e4bc1e45ae16d259d0cdaa0eb85

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2014 YOURNAME
+
+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.rdoc

@@ -0,0 +1,3 @@
+= Templatr
+
+This project rocks and uses MIT-LICENSE.

data/Rakefile

@@ -0,0 +1,34 @@
+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    = 'Templatr'
+  rdoc.options << '--line-numbers'
+  rdoc.rdoc_files.include('README.rdoc')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+APP_RAKEFILE = File.expand_path("../test/dummy/Rakefile", __FILE__)
+load 'rails/tasks/engine.rake'
+
+
+
+Bundler::GemHelper.install_tasks
+
+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/app/assets/javascripts/templatr/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 vendor/assets/javascripts of plugins, if any, 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/sstephenson/sprockets#sprockets-directives) for details
+// about supported directives.
+//
+//= require_tree .

data/app/assets/stylesheets/templatr/application.css

@@ -0,0 +1,13 @@
+/*
+ * 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 vendor/assets/stylesheets of plugins, if any, 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 top of the
+ * compiled file, but it's generally better to create a new file per style scope.
+ *
+ *= require_self
+ *= require_tree .
+ */

data/app/controllers/templatr/application_controller.rb

@@ -0,0 +1,4 @@
+module Templatr
+  class ApplicationController < ActionController::Base
+  end
+end

data/app/helpers/templatr/application_helper.rb

@@ -0,0 +1,4 @@
+module Templatr
+  module ApplicationHelper
+  end
+end

data/app/models/templatr/field.rb

@@ -0,0 +1,168 @@
+module Templatr
+	class Field < ActiveRecord::Base
+	  has_many :field_values, :dependent => :destroy
+	  has_many :tags, :inverse_of => :field
+
+	  belongs_to :field_group
+
+	  scope :common, where(:template_id => nil)
+	  scope :specific, where("template_id IS NOT NULL")
+	  scope :common_or_specific_type, lambda {|type| where("template_id IS NULL OR template_id = ?", type.id) }
+	  scope :show_tag_cloud, where('show_tag_cloud').order('"order" ASC, id ASC')
+	  scope :included_in_item_list, where('include_in_item_list').order('"order" ASC, id ASC')
+	  scope :with_name, lambda {|name| where("LOWER(name) = LOWER(?) ", name) }
+
+	  def self.search_suggestions(value = true); where(:search_suggestions => value); end
+
+	  def self.templatable_class
+	    self.to_s.gsub(/Field\Z/, '').constantize
+	  end
+
+	  # Reserved field names that the user is not allowed to use
+	  # "Type" is reserved to differentiate between Templates
+	  def self.reserved_fields
+	    [:type] + templatable_class.attribute_names.collect(&:to_sym) + templatable_class.reflect_on_all_associations.collect(&:name)
+	  end
+
+	  def self.valid_field_types
+	    %w(string text float integer boolean integer_with_uncertainty select_one select_multiple)
+	  end
+
+	  # The valid ways to migrate data between field types
+	  def self.valid_migration_paths
+	    { :string          => [:select_one, :select_multiple, :text],
+	      :select_one      => [:string, :select_multiple, :text]
+	    }.with_indifferent_access
+	  end
+
+	  def self.valid_migration_path?(from, to)
+	    paths = valid_migration_paths[from]
+	    paths && paths.include?(to.to_sym)
+	  end
+
+	  def valid_migration_paths
+	    new_record? ? self.class.valid_field_types : [self.field_type] + Array(self.class.valid_migration_paths[self.field_type])
+	  end
+
+	  accepts_nested_attributes_for :field_values, :allow_destroy => true, :reject_if => :all_blank
+
+	  validates_inclusion_of :field_type, :in => valid_field_types
+
+	  validates_presence_of :name
+	  validate :has_unique_name
+	  validates_exclusion_of :name, :in => lambda {|f| CSVSerializer.han(f.class.templatable_class, f.class.reserved_fields, :downcase => true) }
+
+	  after_save :disambiguate_fields, :migrate_field_type
+	  after_destroy :disambiguate_fields
+
+	  def string?;                   field_type == 'string' end
+	  def text?;                     field_type == 'text' end
+	  def boolean?;                  field_type == 'boolean' end
+	  def float?;                    field_type == 'float' end
+	  def integer?;                  field_type == 'integer' end
+	  def integer_with_uncertainty?; field_type == 'integer_with_uncertainty' end
+	  def select?;                   field_type == 'select_one' || field_type == 'select_multiple' end
+	  def select_one?;               field_type == 'select_one' end
+	  def select_multiple?;          field_type == 'select_multiple' end
+
+	  def to_s
+	    self.name
+	  end
+
+	  def common?
+	    template_id.nil?
+	  end
+
+	  def facet?
+	    include_in_search_form? || search_suggestions?
+	  end
+
+	  # Don't allow changes to the type if the field is saved
+	  def can_change_type?
+	    new_record? || self.class.valid_migration_paths[self.field_type].present?
+	  end
+
+	  def scalar?
+	    string? || text? || boolean? || float? || integer? || integer_with_uncertainty?
+	  end
+
+	  def vector?
+	    !scalar?
+	  end
+
+	  # Coerce the field_type to a string at all times so testing for it is easier
+	  def field_type=(value)
+	    super(value.to_s)
+	  end
+
+	  # GLINT INTEGRATION
+
+	  # What attribute type should glint use to store this field's values
+	  def attribute_type
+	    (float? || integer? || text? || boolean? ? field_type : 'string').to_sym
+	  end
+
+	  def facet_name
+	    :"field_#{id}"
+	  end
+
+	  def param
+	    (self.disambiguate? ? "#{template.name} #{self.name}" : self.name).downcase # param is always case insensitive
+	  end
+
+	  private
+
+	  def migrate_field_type
+	    return unless field_type_changed? && field_type_was.present?
+
+	    if self.class.valid_migration_path?(field_type_was, self.field_type)
+	      new_field_type = self.field_type
+	      self.field_type = field_type_was
+
+	      tags.collect do |tag|
+	        [tag, tag.value]
+	      end.tap do
+	        self.field_type = new_field_type
+	      end.each do |tag, old_value|
+	        tag.value = old_value
+	        tag.save!
+	      end
+
+	      # Unhook the old field values
+	      unless select?
+	        tags.each do |tag|
+	          tag.update_attribute(:field_value, nil)
+	          tag.field_values = []
+	        end
+	        field_values.destroy_all
+	      end
+	    else
+	      raise "Can't convert from a #{field_type_was} to #{field_type} field"
+	    end
+	  end
+
+	  def has_unique_name
+	    scope = self.class.where("LOWER(name) = LOWER(?)", self.name)
+	    scope = scope.where("id != ?", self.id) if self.id
+	    scope = scope.where(:template_id => [nil, self.template_id]) if self.template_id
+
+	    errors.add(:name, "has already been taken") if scope.exists?
+	  end
+
+	  # Finds all fields with the same name and ensures they know there is another field with the same name
+	  # thus allowing us to have them a prefix that lets us identify them in a query string
+	  def disambiguate_fields
+	    if name_changed? # New, Updated
+	      fields = self.class.specific.where("LOWER(name) = LOWER(?)", self.name)
+	      fields.update_all(:disambiguate => fields.many?)
+	    end
+
+	    if name_was # Updated, Destroyed
+	      fields = self.class.specific.where("LOWER(name) = LOWER(?)", self.name_was)
+	      fields.update_all(:disambiguate => fields.many?)
+	    end
+	  end
+
+	  # END GLINT INTEGRATION
+	end
+end

data/app/models/templatr/field_group.rb

@@ -0,0 +1,5 @@
+module Templatr
+	class FieldGroup < ActiveRecord::Base
+	  has_many :fields
+	end
+end

data/app/models/templatr/field_value.rb

@@ -0,0 +1,13 @@
+module Templatr
+  class FieldValue < ActiveRecord::Base
+    belongs_to :field
+
+    has_many :tag_field_values # Don't need to destroy this because tags will take care of the link tables
+
+    validates_presence_of :field_id, :value
+
+    def to_s
+      self.value
+    end
+  end
+end

data/app/models/templatr/tag.rb

@@ -0,0 +1,120 @@
+# encoding: UTF-8
+module Templatr
+  class Tag < ActiveRecord::Base
+    belongs_to :field, :inverse_of => :tags
+
+    # Select
+    belongs_to :field_value
+
+    # Select Multiple
+    has_many :tag_field_values, :dependent => :destroy
+    has_many :field_values, :through => :tag_field_values
+
+    delegate :scalar?, :vector?, :string?, :text?, :select_one?, :select_multiple?, :boolean?, :float?, :integer?, :integer_with_uncertainty?, :to => :field
+
+    before_validation :mark_for_destruction_if_blank
+
+    attr_writer :value # Allows the setting and getting of the value, before it has been persisted
+    before_save :persist_value
+
+    def self.templatable_class
+      self.to_s[/[A-Z][a-z]+/].constantize
+    end
+
+    def custom_tag?
+      !field
+    end
+
+    def name
+      custom_tag? ? self['name'] : field.name
+    end
+
+    def value
+      if !@value.nil?
+        @value
+      elsif custom_tag? || string?
+        string_value
+      elsif text?
+        text_value
+      elsif select_one?
+        field_value.to_s
+      elsif select_multiple?
+        field_values.collect(&:to_s)
+      elsif boolean?
+        boolean_value
+      elsif float?
+        float_value
+      elsif integer?
+        integer_value
+      elsif integer_with_uncertainty?
+        _value = integer_value.to_s
+        _value << " ± #{integer_value_uncertainty}" if integer_value_uncertainty
+        _value
+      else
+        raise "Unknown Field Type: #{field.field_type.inspect}"
+      end
+    end
+
+    def to_s
+      value.is_a?(Array) ? value.join(', ') : value
+    end
+
+    def field_group_id
+      field.field_group_id if field
+    end
+
+    # Allow field value to be set by passing a string
+    def field_value=(value)
+      super find_or_create_field_value(value)
+    end
+
+    # Allow field value to be set by passing a string
+    def field_values=(value)
+      super Array.wrap(value).collect {|value| find_or_create_field_value(value) }
+    end
+
+    private
+
+    def find_or_create_field_value(value)
+      case value
+      when String
+        field.field_values.where(:value => value).first_or_create!
+      else
+        value
+      end
+    end
+
+    def persist_value
+      if custom_tag? || string?
+        self.string_value = @value.to_s # Ensure that if an AR object is passed, it doesn't turn into the record id
+      elsif text?
+        self.text_value = @value.to_s
+      elsif select_one?
+        self.field_value = @value
+      elsif select_multiple?
+        self.field_values = @value
+      elsif boolean?
+        self.boolean_value = @value
+      elsif float?
+        self.float_value = @value.to_s
+      elsif integer?
+        self.integer_value = @value.to_s
+      elsif integer_with_uncertainty?
+        self.integer_value = @value.first.to_s
+        self.integer_value_uncertainty = @value.second
+      else
+        raise "Unknown Field Type: #{field.field_type.inspect}"
+      end
+
+      puts "persisted value '#{value}'"
+
+      return true # Ensure that if we set a value to false we don't accidentally cancel the save
+    end
+
+    def mark_for_destruction_if_blank
+      # Tell the parent object to delete this tag when saving if it is a nil value
+      # NOTE: Boolean's false value evaluates to blank, but should be interpreted as present
+      @marked_for_destruction = (boolean? ? self.value.nil? : self.value.blank?).presence
+    end
+  end
+end

data/app/models/templatr/tag_field_value.rb

@@ -0,0 +1,6 @@
+module Templatr
+	class TagFieldValue < ActiveRecord::Base
+	  belongs_to :field_value
+	  belongs_to :tag
+	end
+end

data/app/models/templatr/template.rb

@@ -0,0 +1,54 @@
+module Templatr
+  class Template < ActiveRecord::Base
+    validates :name, :presence => true, :uniqueness => {:case_sensitive => false}
+    validate :unique_field_names
+
+    after_validation :add_field_uniqueness_errors
+
+    def self.templatable_class
+      self.to_s[/[A-Z][a-z]+/].constantize
+    end
+
+    # Combined common and default fields
+    def template_fields
+      common_fields + default_fields
+    end
+
+    def to_s
+      self.name
+    end
+
+    # In order to make common fields appear on a new form, we need to make the has_many association think that it should load them from the database
+    # We do so by pretending we have a primary key, knowing that it will evaluate to null
+    def attribute_present?(attribute)
+      attribute.to_s == 'common_fields_fake_foreign_key' ? true : super
+    end
+
+    # Ensure all nested attributes for common fields get saved as common fields, and not as template fields
+    def common_fields_attributes=(nested_attributes)
+      nested_attributes.values.each do |attributes|
+        common_field = common_fields.find {|field| field.id.to_s == attributes[:id] && attributes[:id].present? } || common_fields.build
+        assign_to_or_mark_for_destruction(common_field, attributes, true, {})
+      end
+    end
+
+    private
+
+    def unique_field_names
+      names = template_fields.reject(&:marked_for_destruction?).collect {|f| f.name.downcase }
+
+      errors.add(:base, "fields aren't unique") if names.uniq!
+    end
+
+    # This needs to run after validation because we don't want the child models to clear these errors when they validate
+    def add_field_uniqueness_errors
+      names = template_fields.reject(&:marked_for_destruction?).collect {|f| f.name.downcase }
+
+      template_fields.each do |field|
+        if names.count(field.name.downcase) > 1
+          field.errors.add(:name, "has already been taken")
+        end
+      end
+    end
+  end
+end

data/app/views/layouts/templatr/application.html.erb

@@ -0,0 +1,14 @@
+<!DOCTYPE html>
+<html>
+<head>
+  <title>Templatr</title>
+  <%= stylesheet_link_tag    "templatr/application", media: "all" %>
+  <%= javascript_include_tag "templatr/application" %>
+  <%= csrf_meta_tags %>
+</head>
+<body>
+
+<%= yield %>
+
+</body>
+</html>

data/config/routes.rb

@@ -0,0 +1,2 @@
+Templatr::Engine.routes.draw do
+end

data/lib/tasks/templatr_tasks.rake

@@ -0,0 +1,4 @@
+# desc "Explaining what the task does"
+# task :templatr do
+#   # Task goes here
+# end

data/lib/templatr/acts_as_templatable.rb

@@ -0,0 +1,154 @@
+module Templatr
+  module ActsAsTemplatable
+    module ActMethod
+      def acts_as_templatable(options = {})
+        extend Templatr::ActsAsTemplatable::ClassMethods
+        include Templatr::ActsAsTemplatable::InstanceMethods
+
+        Templatr::ActsAsTemplatable::HelperMethods.create_field_class(self)
+        Templatr::ActsAsTemplatable::HelperMethods.create_tag_class(self)
+        Templatr::ActsAsTemplatable::HelperMethods.create_template_class(self)
+
+        TagFieldValue.belongs_to tag_class(false).underscore.to_sym, :foreign_key => :tag_id
+
+        FieldValue.has_many tag_class(false).tableize.to_sym, :dependent => :destroy # Destroy all single select tags with this field value
+        FieldValue.has_many :"single_value_#{name.tableize}", :source => name.underscore.to_sym, :through => tag_class(false).tableize.to_sym
+
+        FieldValue.has_many :"multi_value_#{tag_class(false).tableize}", :source => tag_class(false).underscore.to_sym, :through => :tag_field_values, :dependent => :destroy # Destroy all multi select tags with this field value
+        FieldValue.has_many :"multi_value_#{name.tableize}", :source => name.underscore.to_sym, :through => :"multi_value_#{tag_class(false).tableize}"
+
+        FieldValue.send(:define_method, name.tableize) do
+          if field.select_one?
+            single_value_items
+          elsif field.select_multiple?
+            multi_value_items
+          end
+        end
+
+        class_eval do
+          belongs_to :template, :class_name => template_class
+          delegate :template_fields, :to => :template
+
+          has_many :tags, :class_name => tag_class, :foreign_key => :taggable_id, :order => 'templatr_tags.name ASC', :dependent => :destroy
+          accepts_nested_attributes_for :tags, :allow_destroy => true
+
+          class_attribute :dynamic_facets
+          self.dynamic_facets = []
+        end
+      end
+    end
+
+    module ClassMethods
+      def template_class(constantize = true)
+        klass = "#{self}Template"
+        constantize ? klass.constantize : klass
+      end
+
+      def field_class(constantize = true)
+        klass = "#{self}Field"
+        constantize ? klass.constantize : klass
+      end
+
+      def tag_class(constantize = true)
+        klass = "#{self}Tag"
+        constantize ? klass.constantize : klass
+      end
+
+      def search_class(constantize = true)
+        klass = "#{self}Search"
+        constantize ? klass.constantize : klass
+      end
+
+      def update_dynamic_facets
+        # Load the dynamic fields
+        current_dynamic_facets = []
+
+        field_class.find_each do |field|
+          current_dynamic_facets << field.facet_name
+
+          define_method field.facet_name do
+            tags.detect {|t| t.field_id == field.id }.try(:value) # Detect instead of SQL constrain so we can eager load the tags association
+          end unless field.facet_name.in?(dynamic_facets)
+
+          has_facet field.facet_name, :attribute_type => field.attribute_type, :multiple => field.select_multiple?, :param => field.param
+        end
+
+        # Disable all facets that no longer exist
+        (dynamic_facets - current_dynamic_facets).each {|facet_name| search_class.disable_facet(facet_name) }
+
+        self.dynamic_facets = current_dynamic_facets
+      end
+    end
+
+    module InstanceMethods
+      # Returns true if the record is still able to choose which template to use
+      def can_change_template?
+        !persisted? || !template.present?
+      end
+
+      def template_tags(options = {})
+        existing_tags = tags.joins(:field).reorder('templatr_fields.field_group_id, templatr_fields.order')
+
+        return existing_tags unless options[:include_blank]
+
+        # Add non-populated tags so that they show in the form
+        template_fields.collect do |field|
+          existing_tags.detect {|tag| tag.field == field } || Tag.new(:field => field)
+        end
+      end
+
+      def additional_tags
+        tags.where("field_id IS NULL")
+      end
+    end
+
+		module HelperMethods
+			def self.create_field_class(templatable_class)
+        field_class = create_class(templatable_class.field_class(false), 'Templatr::Field')
+
+        field_class.belongs_to :template, :class_name => templatable_class.template_class(false), :foreign_key => :template_id, :inverse_of => :default_fields
+
+			  field_class.has_many :tags, :class_name => templatable_class.tag_class(false), :foreign_key => :field_id, :dependent => :destroy, :inverse_of => :field
+			  field_class.has_many templatable_class.tag_class(false).tableize.to_sym, :through => :tags
+
+        return field_class
+      end
+
+      def self.create_tag_class(templatable_class)
+        tag_class = create_class(templatable_class.tag_class(false), 'Templatr::Tag')
+
+        tag_class.belongs_to templatable_class.to_s.underscore.to_sym, :foreign_key => :taggable_id
+
+        return tag_class
+      end
+
+      def self.create_template_class(templatable_class)
+        template_class = create_class(templatable_class.template_class(false), 'Templatr::Template')
+
+        template_class.has_many :items, :foreign_key => :template_id, :dependent => :destroy
+        template_class.has_many :default_fields, :class_name => templatable_class.field_class(false), :foreign_key => :template_id, :order => 'templatr_fields.field_group_id, templatr_fields.order, templatr_fields.id', :dependent => :destroy, :inverse_of => :template
+        template_class.has_many :common_fields, :class_name => templatable_class.field_class(false), :foreign_key => :template_id, :order => 'templatr_fields.field_group_id, templatr_fields.order, templatr_fields.id', :primary_key => 'common_fields_fake_foreign_key'
+
+        template_class.accepts_nested_attributes_for :default_fields, :common_fields, :allow_destroy => true
+
+        return template_class
+      end
+
+      def self.create_class(klass_name, parent_klass)
+        class_header = "class ::"
+        class_header << klass_name
+        class_header << " < #{parent_klass}" if parent_klass
+
+        begin
+          klass_name.constantize
+          puts "#{klass_name} has already been created"
+        rescue => e
+          puts "Creating class #{klass_name}"
+          eval "#{class_header}; end"
+        end
+
+        return klass_name.constantize
+      end
+    end
+  end
+end

data/lib/templatr/engine.rb

@@ -0,0 +1,11 @@
+require 'templatr/acts_as_templatable'
+
+module Templatr
+  class Engine < ::Rails::Engine
+    isolate_namespace Templatr
+
+    initializer "templatr.init" do
+      ActiveRecord::Base.extend ActsAsTemplatable::ActMethod
+    end
+  end
+end

data/lib/templatr/version.rb

@@ -0,0 +1,3 @@
+module Templatr
+  VERSION = "0.0.1"
+end

data/lib/templatr.rb

@@ -0,0 +1,4 @@
+require "templatr/engine"
+
+module Templatr
+end