selections 0.0.1 → 0.1.1

data/lib/selections/selectable.rb

@@ -0,0 +1,125 @@
+require 'acts_as_tree'
+
+module Selections
+  module Selectable
+
+    module ModelMixin
+      extend ActiveSupport::Concern
+
+      HIDDEN_POSITION = 999888777 #:nodoc:
+
+      included do
+        # Setup any required model information for a selectable model.
+        acts_as_tree
+
+        validate :name, :existence => true
+        validates_presence_of :name
+        validates_uniqueness_of :name, :scope => :parent_id
+        validates_uniqueness_of :system_code, :scope => :archived_at
+        validates_format_of :system_code, :with => /^[a-z][a-zA-Z_0-9]*$/, :message => "can only contain alphanumeric characters and '_', not spaces"
+
+        before_validation :auto_gen_system_code, :on => :create
+        before_validation :disable_system_code_change, :on => :update
+        after_validation :check_defaults
+
+        default_scope :order => [:position_value, :name]
+
+        scope :filter_archived_except_selected, lambda { |selected_id| {:conditions => ["archived_at is ? or id = ?", nil, selected_id.to_i]} }
+      end
+
+      module ClassMethods
+        # Dynamic Lookups
+        #
+        # Assuming there is a list with the following system_codes
+        #
+        # example of a nested list of system codes:
+        # * priority
+        # * - high
+        # * - medium
+        # * - low
+        #
+        # Selection.priority => return priority instance
+        #
+        # Selection.priorities => returns [high, medium, low] instances (children)
+
+        def method_missing lookup_code, *options
+          if (scope = where(:system_code => lookup_code.to_s)).exists?
+            scope.first
+          elsif (scope = where(:system_code => lookup_code.to_s.singularize)).exists?
+            scope.first.children
+          else
+            super
+          end
+        end
+
+      end
+
+      def to_s #:nodoc:
+        name.to_s
+      end
+
+      # Returns boolean true if current node has no children
+      def leaf?
+        children.where(parent_id: self.id).empty?
+      end
+
+      # Returns childrens children from root or any point
+      def level_2
+        Selection.where(parent_id: child_ids)
+      end
+
+      def position=(value) #:nodoc:
+        self.position_value = value || HIDDEN_POSITION
+      end
+
+      def disable_system_code_change #:nodoc:
+        errors.add(:system_code, "cannot be changed") if system_code_changed?
+      end
+
+      def position #:nodoc:
+        position_value unless position_value == HIDDEN_POSITION
+      end
+
+      def auto_gen_system_code #:nodoc:
+        unless system_code
+          self.system_code= name.to_s.underscore.split(" ").join("_").singularize.underscore.gsub(/\W/, "_")
+          self.system_code= parent.system_code + "_" + self.system_code if parent
+          self.system_code.gsub!(/\_{2,}/, '_')
+        end
+      end
+
+      def check_defaults #:nodoc:
+        siblings_with_default_set.update_attribute(:is_default, false) if self.parent && siblings_with_default_set && self.is_default
+        self.is_default = false if archived
+      end
+
+      def siblings_with_default_set #:nodoc:
+        self.parent.children.where(:is_default => true).where("id != ?", self.id.to_i).first
+      end
+
+      def archived #:nodoc:
+        !!archived_at
+      end
+
+      def archived=(archived_checkbox) #:nodoc:
+        if archived_checkbox == "1"
+          self.archived_at = Time.now unless archived_at
+        else
+          self.archived_at = nil
+        end
+      end
+
+      def sub_children
+        children.flat_map(&:children)
+      end
+    end
+
+    def selectable #:nodoc:
+      include ModelMixin
+    end
+
+    ActiveSupport.on_load :active_record do
+      extend Selections::Selectable
+    end
+  end
+end

data/lib/selections/version.rb

@@ -1,3 +1,3 @@
 module Selections
-  VERSION = "0.0.1"
+  VERSION = "0.1.1"
 end

data/selections.gemspec

@@ -0,0 +1,38 @@
+# -*- encoding: utf-8 -*-
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'selections/version'
+
+Gem::Specification.new do |gem|
+  gem.name          = "selections"
+  gem.version       = Selections::VERSION
+  gem.authors       = ["Nigel Rausch"]
+  gem.email         = ["nigelr@brisbanerails.com"]
+  gem.description   = %q{Selection list management and form and view helpers.
+ Manages one table to hold all selections items/dropdown lists ( tree ).
+ Dynamic lookup to find parent or children ( eg. Selection.priorities ).
+ Form helper to display lists ( eg. f.selections :priorities ).
+ Handling of archived items ( displaying if selected only ).
+}
+  gem.summary       = %q{Selection list management and form and view helpers.
+ Manages one table to hold all selections items/dropdown lists ( tree ).
+ Dynamic lookup to find parent or children ( eg. Selection.priorities ).
+ Form helper to display lists ( eg. f.selections :priorities ).
+ Handling of archived items ( displaying if selected only ).
+}
+  gem.homepage      = "https://github.com/nigelr/selections"
+  gem.files         = `git ls-files`.split($/)
+  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.require_paths = ["lib"]
+
+  gem.add_dependency 'activerecord', '~> 3.0'
+  gem.add_dependency 'actionpack',   '~> 3.0'
+  gem.add_dependency 'acts_as_tree', '~> 1.2.0'
+
+  gem.add_development_dependency 'rake'
+  gem.add_development_dependency 'rspec'
+  gem.add_development_dependency 'sqlite3'
+  gem.add_development_dependency 'nokogiri'
+
+end

data/spec/selections/selectable_spec.rb

@@ -0,0 +1,220 @@
+require "spec_helper"
+
+describe Selections do
+  let(:parent) { Selection.create(name: "priority") }
+  let(:selection_1) { Selection.create(name: "low", parent_id: parent.id) }
+  let(:selection_2) { Selection.create(name: "medium", parent_id: parent.id) }
+  let(:selection_3) { Selection.create(name: "high", parent_id: parent.id) }
+
+  describe ".filter_archived_except_selected" do
+    before do
+      selection_1
+      selection_2
+    end
+    it "returns all when none selected" do
+      parent.children.filter_archived_except_selected(nil)
+      expect(parent.children.filter_archived_except_selected(nil)).to match_array([selection_2, selection_1])
+    end
+    it "returns all even when selected" do
+      expect(parent.children.filter_archived_except_selected(selection_2.id)).to match_array([selection_2, selection_1])
+    end
+    context "archived" do
+      before :each do
+        selection_2.update_attribute(:archived, "1")
+      end
+      it "returns unarchived items" do
+        expect(parent.children.filter_archived_except_selected(nil)).to match_array([selection_1])
+      end
+      it "returns only unarchived items when archived is not selected" do
+        expect(parent.children.filter_archived_except_selected(selection_1.id)).to match_array([selection_1])
+      end
+      it "returns archived item if selected" do
+        expect(parent.children.filter_archived_except_selected(selection_2.id)).to match_array([selection_2, selection_1])
+      end
+    end
+  end
+
+  describe ".to_s" do
+    it "returns name" do
+      expect(selection_1.to_s).to eq(selection_1.name)
+    end
+  end
+
+
+  describe ".leaf?" do
+    it { selection_1; expect(parent.leaf?).to be_false }
+    it { expect(selection_1.leaf?).to be_true }
+  end
+
+  describe ".sub_children" do
+    before do
+      selection_1.children = [Selection.create(name: "sub_1"), Selection.create(name: "sub_2")]
+      selection_2.children = [Selection.create(name: "sub_3")]
+    end
+    it "gets all the childrens children" do
+      expect(parent.sub_children).to match_array(selection_1.children + selection_2.children)
+    end
+    it "return empty array from leaf" do
+      expect(selection_1.children.first.sub_children).to eq([])
+    end
+  end
+
+  describe ".position=" do
+    it "sets to HIDDEN_POSITION if blank" do
+      expect(Selection.create(name: "position", position: nil).position_value).to eq(Selection::HIDDEN_POSITION)
+    end
+    it "sets to position_value to 45" do
+      expect(Selection.create(name: "position", position: 45).position_value).to eq(45)
+    end
+  end
+
+  describe ".position" do
+    it "should display position if not HIDDEN_POSITION" do
+      expect(Selection.create(name: "position", position: 46).position).to eq(46)
+    end
+    it "should not display position if HIDDEN_POSITION" do
+      expect(Selection.create(name: "position", position: nil).position).to be_nil
+    end
+  end
+
+  describe ".auto_gen_system_code" do
+    it "only generates if blank" do
+      expect(Selection.create(name: "position", system_code: "hello_world").system_code).to eq("hello_world")
+    end
+
+    context "chaining of system_codes" do
+      before do
+        @parent = Selection.create(name: "Board Chairman")
+      end
+      it "create system_code from name" do
+        expect(@parent.system_code).to eq("board_chairman")
+      end
+      context "child" do
+        before do
+          @child = Selection.create(name: "CEO", parent: @parent)
+        end
+        it "create system_code from name" do
+          expect(@child.system_code).to eq("board_chairman_ceo")
+        end
+        context "child" do
+          it "create system_code from name" do
+            expect(Selection.create(name: "head janitor", parent: @child).system_code).to eq("board_chairman_ceo_head_janitor")
+          end
+        end
+      end
+    end
+  end
+
+  describe ".siblings_with_default_set" do
+    before do
+      selection_1
+      selection_2
+      selection_3
+    end
+    it "returns none when no default set" do
+      expect(selection_2.siblings_with_default_set).to eq(nil)
+    end
+    context "default set" do
+      before do
+        selection_2.update_attribute(:is_default, true)
+      end
+      it "returns item with default set" do
+        expect(selection_1.siblings_with_default_set).to eq(selection_2)
+      end
+      it "does not returns item with default set when self" do
+        expect(selection_2.siblings_with_default_set).to eq(nil)
+      end
+    end
+  end
+
+  describe ".check_defaults" do
+    before do
+      selection_1
+      selection_2
+      selection_3
+    end
+    it("selection_1 should not be set") { expect(selection_1.reload.is_default).to be_false }
+    it("selection_2 should not be set") { expect(selection_2.reload.is_default).to be_false }
+    it("selection_3 should not be set") { expect(selection_3.reload.is_default).to be_false }
+
+    context "setting one item to default" do
+      before { selection_2.update_attributes(is_default: true) }
+      it("should set self as default") { expect(selection_2.reload.is_default).to be_true }
+      it("selection_1 should not be set") { expect(selection_1.reload.is_default).to be_false }
+      it("selection_3 should not be set") { expect(selection_3.reload.is_default).to be_false }
+      context "setting same item to default" do
+        before { selection_2.update_attributes(is_default: true) }
+        it("should set self as default") { expect(selection_2.reload.is_default).to be_true }
+        it("selection_1 should not be set") { expect(selection_1.reload.is_default).to be_false }
+        it("selection_3 should not be set") { expect(selection_3.reload.is_default).to be_false }
+      end
+      context "setting other item to default" do
+        before { selection_1.update_attributes(is_default: true) }
+        it("should set self as default") { expect(selection_1.reload.is_default).to be_true }
+        it("selection_2 should not be set") { expect(selection_2.reload.is_default).to be_false }
+        it("selection_3 should not be set") { expect(selection_3.reload.is_default).to be_false }
+      end
+      context "removing default setting" do
+        before { selection_2.update_attributes(is_default: false) }
+        it("should unset self as default") { expect(selection_1.reload.is_default).to be_false }
+        it("selection_2 should not be set") { expect(selection_2.reload.is_default).to be_false }
+        it("selection_3 should not be set") { expect(selection_3.reload.is_default).to be_false }
+      end
+      context "archive item with default" do
+        before { selection_2.update_attributes(archived: "1") }
+        it("should unset self as default") { expect(selection_2.reload.is_default).to be_false }
+        it("selection_1 should not be set") { expect(selection_1.reload.is_default).to be_false }
+        it("selection_3 should not be set") { expect(selection_3.reload.is_default).to be_false }
+      end
+    end
+  end
+
+  describe ".archived=" do
+    before do
+      @stubbed_time = Time.parse("01/01/2010 10:00")
+      Time.stub(:now).and_return(@stubbed_time)
+      selection_1.update_attributes(archived: "1")
+    end
+
+    it "should set archived" do
+      expect(selection_1.archived_at).to eq @stubbed_time
+    end
+    it "remain archived and not change date when set again" do
+      Time.stub(:now).and_return(Time.parse("12/12/2012 10:00"))
+      selection_1.update_attributes(archived: "1")
+      expect(selection_1.archived_at).to eq @stubbed_time
+    end
+    it "un-archives item" do
+      selection_1.update_attributes(archived: "0")
+      expect(selection_1.archived_at).to be_nil
+    end
+  end
+
+  describe ".archived" do
+    it "when archived set" do
+      selection_1.update_attributes(archived: "1")
+      expect(selection_1.archived).to be_true
+    end
+    it "when archived set" do
+      selection_1.update_attributes(archived: "0")
+      expect(selection_1.archived).to be_false
+    end
+  end
+
+  context "selecting" do
+    before do
+      selection_1
+      selection_2
+    end
+    it "singular" do
+      expect(Selection.send(parent.system_code)).to eq(parent)
+    end
+    it "plural" do
+      expect(Selection.send(parent.system_code.pluralize)).to eq(parent.children)
+    end
+    #TODO this needs to ne an option
+    #it "should not error when non existent" do
+    #  expect(Selection.non_existent_system_code).to eq([])
+    #end
+  end
+end

data/spec/selections/selections_tag_spec.rb

@@ -0,0 +1,203 @@
+require "spec_helper"
+
+
+include Selections::FormBuilderExtensions
+describe SelectionTag do
+  let(:parent) { Selection.create(name: "priority") }
+  let(:model_parent) { Selection.create(name: "ticket_priority") }
+  let(:selection_1) { Selection.create(name: "low", parent_id: parent.id) }
+  let(:selection_2) { Selection.create(name: "medium", parent_id: parent.id) }
+  let(:selection_3) { Selection.create(name: "high", parent_id: parent.id) }
+  let(:form) { ActionView::Helpers::FormBuilder.new(:ticket, ticket, ActionView::Base.new, {}, Proc.new {}) }
+  let(:ticket) { Ticket.create(:name => "railscamp") }
+  let(:all_selections) do
+    parent
+    selection_1
+    selection_2
+    selection_3
+  end
+
+
+  describe ".system_code" do
+    context "direct parent" do
+      before { parent }
+      it "returns priority selection item" do
+        expect(SelectionTag.new(form, ticket, :priority, {}, {}).system_code).to eq(parent)
+      end
+      it "does not find" do
+        expect(SelectionTag.new(form, ticket, :non_existent, {}, {}).system_code).to be_nil
+      end
+    end
+
+    it "finds with form model prefixed" do
+      model_parent
+      expect(SelectionTag.new(form, ticket, :priority, {}, {}).system_code).to eq(model_parent)
+    end
+  end
+
+  describe ".items" do
+    before { all_selections }
+
+    it "returns all children items" do
+      expect(SelectionTag.new(form, ticket, :priority, {}, {}).items.all).to eq(parent.children)
+    end
+    context "archived" do
+      before { selection_2.update_attribute(:archived, "1") }
+      it "returns only non archived items" do
+        expect(SelectionTag.new(form, ticket, :priority, {}, {}).items).to eq(parent.children - [selection_2])
+      end
+      it "returns archived items when selected" do
+        ticket.update_attribute(:priority_id, selection_2.id)
+        expect(SelectionTag.new(form, ticket, :priority, {}, {}).items.all).to eq(parent.children)
+      end
+    end
+  end
+
+  describe ".field_id" do
+    it("when string") { expect(SelectionTag.new(nil, nil, "priority", {}, {}).field_id).to eq(:priority_id) }
+    it("when symbol") { expect(SelectionTag.new(nil, nil, :priority, {}, {}).field_id).to eq(:priority_id) }
+  end
+
+  describe ".system_code_name" do
+    it("sets to field name") { expect(SelectionTag.new(nil, nil, :priority, {}, {}).system_code_name).to eq(:priority) }
+    it("when override system_code") { expect(SelectionTag.new(nil, nil, :hello, {}, {system_code: :priority}).system_code_name).to eq(:priority) }
+  end
+
+  context "include blank" do
+    before { all_selections }
+
+    context "when not set" do
+      context "new form" do
+        it("has blank") { expect(SelectionTag.new(form, Ticket.new, :priority, {}, {}).include_blank?).to be_true }
+        it "has no blank when default set" do
+          selection_1.update_attribute(:is_default, true)
+          expect(SelectionTag.new(form, Ticket.new, :priority, {}, {}).include_blank?).to be_false
+        end
+      end
+      context "edit form" do
+        it("has no blank when ticket.priority_id is set") do
+          ticket.update_attribute(:priority_id, selection_3.id)
+          expect(SelectionTag.new(form, ticket, :priority, {}, {}).include_blank?).to be_false
+        end
+        it("has blank when ticket.priority_id is nil") { expect(SelectionTag.new(form, ticket, :priority, {}, {}).include_blank?).to be_true }
+        it "has no blank when ticket.priority_id is nil and default set" do
+          selection_1.update_attribute(:is_default, true)
+          expect(SelectionTag.new(form, ticket, :priority, {}, {}).include_blank?).to be_false
+        end
+      end
+    end
+
+    context "when set false" do
+      context "new form" do
+        it("has no blank") { expect(SelectionTag.new(form, Ticket.new, :priority, {}, {include_blank: false}).include_blank?).to be_false }
+        it "has no blank when default set" do
+          selection_1.update_attribute(:is_default, true)
+          expect(SelectionTag.new(form, Ticket.new, :priority, {}, {include_blank: false}).include_blank?).to be_false
+        end
+      end
+      context "edit form" do
+        it("has no blank when ticket.priority_id is set") do
+          ticket.update_attribute(:priority_id, selection_3.id)
+          expect(SelectionTag.new(form, ticket, :priority, {}, {include_blank: false}).include_blank?).to be_false
+        end
+        it("has no blank even when ticket.priority_id is nil") { expect(SelectionTag.new(form, ticket, :priority, {}, {include_blank: false}).include_blank?).to be_false }
+        it "has no blank when ticket.priority_id is nil and default set" do
+          selection_1.update_attribute(:is_default, true)
+          expect(SelectionTag.new(form, ticket, :priority, {}, {include_blank: false}).include_blank?).to be_false
+        end
+      end
+    end
+
+    context "when set to true" do
+      context "new form" do
+        it("has blank") { expect(SelectionTag.new(form, Ticket.new, :priority, {}, {include_blank: true}).include_blank?).to be_true }
+        it "has blank even when default set" do
+          selection_1.update_attribute(:is_default, true)
+          expect(SelectionTag.new(form, Ticket.new, :priority, {}, {include_blank: true}).include_blank?).to be_true
+        end
+      end
+      context "edit form" do
+        it("has blank even when ticket.priority_id is set") do
+          ticket.update_attribute(:priority_id, selection_3.id)
+          expect(SelectionTag.new(form, ticket, :priority, {}, {include_blank: true}).include_blank?).to be_true
+        end
+        it("has blank even when ticket.priority_id is nil") { expect(SelectionTag.new(form, ticket, :priority, {}, {include_blank: true}).include_blank?).to be_true }
+        it "has blank even when ticket.priority_id is nil and default set" do
+          selection_1.update_attribute(:is_default, true)
+          expect(SelectionTag.new(form, ticket, :priority, {}, {include_blank: true}).include_blank?).to be_true
+        end
+      end
+    end
+  end
+
+  context ".default_item" do
+    before { all_selections }
+    it "returns nil when no default set" do
+      expect(SelectionTag.new(form, Ticket.new, :priority, {}, {include_blank: false}).default_item).to be_blank
+    end
+    it "should set to default item" do
+      selection_2.update_attribute(:is_default, true)
+      expect(SelectionTag.new(form, Ticket.new, :priority, {}, {include_blank: false}).default_item).to eq(selection_2.id.to_s)
+    end
+  end
+
+  context ".selected_item" do
+    before { all_selections }
+
+    context "when default not set" do
+      it("when new form") { expect(SelectionTag.new(form, Ticket.new, :priority, {}, {}).selected_item).to eq("") }
+      it "when edit form with ticket.priority_id set" do
+        ticket.update_attribute(:priority_id, selection_3.id)
+        expect(SelectionTag.new(form, ticket, :priority, {}, {}).selected_item).to eq(selection_3.id.to_s)
+      end
+      it("when edit form with no ticket.priority_id set") { expect(SelectionTag.new(form, ticket, :priority, {}, {}).selected_item).to eq("") }
+    end
+    context "when default is set" do
+      before { selection_2.update_attribute(:is_default, true) }
+      it("when new form") { expect(SelectionTag.new(form, Ticket.new, :priority, {}, {}).selected_item).to eq(selection_2.id.to_s) }
+      it "when edit form with ticket.priority_id set" do
+        ticket.update_attribute(:priority_id, selection_3.id)
+        expect(SelectionTag.new(form, ticket, :priority, {}, {}).selected_item).to eq(selection_3.id.to_s)
+      end
+      it("when edit form with no ticket.priority_id set") { expect(SelectionTag.new(form, ticket, :priority, {}, {}).selected_item).to eq("") }
+    end
+  end
+
+  describe ".to_tag" do
+    it "displays warning when system_code does not exist" do
+      expect(SelectionTag.new(form, ticket, :priority, {}, {}).to_tag).to eq("Invalid system_code of 'priority'")
+    end
+    context "valid system_code" do
+      before { all_selections }
+
+      context "new form" do
+        context "no default" do
+          it("has no selected item") { expect(Nokogiri::HTML(SelectionTag.new(form, Ticket.new, :priority, {}, {}).to_tag).search("option[selected]")).to be_empty }
+          it("has a blank option") { expect(Nokogiri::HTML(SelectionTag.new(form, Ticket.new, :priority, {}, {}).to_tag).search("option[value='']").count).to eq(1) }
+        end
+        context "default is set" do
+          before { selection_3.update_attribute(:is_default, true) }
+
+          it("has selection_3 selected") { expect(Nokogiri::HTML(SelectionTag.new(form, Ticket.new, :priority, {}, {}).to_tag).search("option[selected]").first.content).to eq(selection_3.name) }
+          it("has no blank option") { expect(Nokogiri::HTML(SelectionTag.new(form, Ticket.new, :priority, {}, {}).to_tag).search("option[value='']").count).to eq(0) }
+        end
+      end
+
+      context "edit form" do
+        context "relation (priority_id) is nil" do
+          it("has no selected item") { expect(Nokogiri::HTML(SelectionTag.new(form, ticket, :priority, {}, {}).to_tag).search("option[selected]")).to be_empty }
+          it("has a blank option") { expect(Nokogiri::HTML(SelectionTag.new(form, ticket, :priority, {}, {}).to_tag).search("option[value='']").count).to eq(1) }
+        end
+        context "when relation (priority_id) is set to selection_3" do
+          before { ticket.update_attribute(:priority_id, selection_3.id) }
+
+          it("item is selected") { expect(Nokogiri::HTML(SelectionTag.new(form, ticket, :priority, {}, {}).to_tag).search("option[selected]").first.content).to eq(selection_3.name) }
+          it("has no blank option") { expect(Nokogiri::HTML(SelectionTag.new(form, ticket, :priority, {}, {}).to_tag).search("option[value='']").count).to eq(0) }
+        end
+      end
+      it "returns valid html" do
+        expect(SelectionTag.new(form, ticket, :priority, {}, {}).to_tag).to eq "<select id=\"ticket_priority_id\" name=\"ticket[priority_id]\"><option value=\"\"></option>\n<option value=\"4\">high</option>\n<option value=\"2\">low</option>\n<option value=\"3\">medium</option></select>"
+      end
+    end
+  end
+end