taxis 0.0.1

data/.gitignore

@@ -0,0 +1,7 @@
+.DS_Store
+*/**/.DS_Store
+*.gem
+.rvmrc
+.bundle
+Gemfile.lock
+pkg/*

data/Gemfile

@@ -0,0 +1,5 @@
+source "http://rubygems.org"
+
+gemspec
+
+gem "rails", "~> 3.0.4"

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (C) 2011 by End Point Corporation
+
+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,42 @@
+# Taxis
+Taxis is a simple Rails 3 plugin that will give you a taxonomy structure for your rails application. It was written with the intent of providing a category tree for e-commerce solutions.  It is in early development right now so please feel free to submit issues and provide any feedback.
+
+# Installation
+
+    gem install taxis
+    
+    rails g taxis:install
+    
+# Dependencies
+Taxis provides a very simple interface for administrating the taxonomy. This interface uses the jsTree javascript library, which is a plugin for jQuery.  As such, the taxis:install generator installs the jquery-rails gem which removes the prototype framework from your application. If this is not desired, use the --skip-jquery option when you run the generator.  The gem also depends on:
+
+ * stringex
+ * nested_set
+
+# License
+
+Copyright (C) 2011 by End Point Corporation
+
+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.
+
+
+# Contributing
+Fork, modify, send me a pull request
+
+

data/Rakefile

@@ -0,0 +1,2 @@
+require 'bundler'
+Bundler::GemHelper.install_tasks

data/app/controllers/admin/base_controller.rb

@@ -0,0 +1,25 @@
+class Admin::BaseController < ApplicationController
+  layout 'admin'
+
+  # For the gem
+  unloadable
+
+
+
+  protected
+
+
+  def tree_children(taxon)
+    children = []
+    taxon.children.each do |taxon|
+      children << {
+        :attr => {:id => taxon.id.to_s},
+        :data => taxon.name,
+        :state => taxon.children.empty? ? "" : "closed"
+      }
+    end
+    
+    return children
+  end
+
+end

data/app/controllers/admin/taxonomies_controller.rb

@@ -0,0 +1,58 @@
+class Admin::TaxonomiesController < Admin::BaseController
+
+
+  def index
+    @taxonomies = Taxonomy.all 
+  end
+
+  def show
+    @taxonomy = Taxonomy.find(params[:id])
+  end
+
+  def new
+    @taxonomy = Taxonomy.new
+  end
+
+  def create
+    @taxonomy = Taxonomy.new(params[:taxonomy])
+    if @taxonomy.save
+      redirect_to edit_admin_taxonomy_url(@taxonomy), :notice => "Successfully created taxonomy."
+    else
+      render :action => 'new'
+    end
+  end
+
+  def edit
+    @taxonomy = Taxonomy.find(params[:id])
+    @tree = root_tree(@taxonomy)
+  end
+
+  def update
+    @taxonomy = Taxonomy.find(params[:id])
+    if @taxonomy.update_attributes(params[:taxonomy])
+      redirect_to admin_taxonomies_url, :notice  => "Successfully updated taxonomy."
+    else
+      render :action => 'edit'
+    end
+  end
+
+  def destroy
+    @taxonomy = Taxonomy.find(params[:id])
+    @taxonomy.destroy
+    redirect_to admin_taxonomies_url, :notice => "Successfully destroyed taxonomy."
+  end
+  
+
+  private
+
+  def root_tree(taxonomy)
+    tree = {
+      :attr => {:id => taxonomy.root.id.to_s, :rel => "root"},
+      :data => taxonomy.root.name,
+      :state => "open",
+      :children => tree_children(taxonomy.root)
+    }
+    return tree
+  end
+
+end

data/app/controllers/admin/taxons_controller.rb

@@ -0,0 +1,94 @@
+class Admin::TaxonsController < Admin::BaseController
+
+  before_filter :find_taxonomy, :except => [:children]
+
+  def index
+
+    if @taxonomy
+      @taxons = @taxonomy.children.order(:pos)
+    else
+      @taxons = Taxon.all
+    end
+
+    respond_to do |format|
+      format.html # index.html.erb
+      format.json  { render :json => @taxons}
+    end
+    
+    
+  end
+
+  def show
+    @taxon = Taxon.find(params[:id])
+  end
+
+  def new
+    @taxon = Taxon.new
+  end
+
+  def create
+    @taxon = Taxon.new(params[:taxon])
+    if @taxon.save
+      redirect_to edit_admin_taxonomy_url(@taxon.taxonomy), :notice => "Successfully created taxon."
+    else
+      render :action => 'new'
+    end
+  end
+
+  def edit
+    @taxon = Taxon.find(params[:id])
+    @taxonomy = @taxon.taxonomy
+  end
+
+  def update
+    @taxon = Taxon.find(params[:id])
+    if @taxon.update_attributes(params[:taxon])
+
+      # Move the taxon to the correct position
+      if params[:left_of_id] != params[:parent_id]
+        @right_taxon = Taxon.find(params[:left_of_id])
+        @taxon.move_to_left_of(@right_taxon) if @right_taxon && @taxon.siblings.include?(@right_taxon)
+      end
+
+      if params[:format] == :json
+        render :json => "ok"
+      else
+        redirect_to edit_admin_taxonomy_url(@taxon.taxonomy), :notice  => "Successfully updated taxon."
+      end
+    else
+      render :action => 'edit'
+    end
+  end
+
+  def destroy
+    @taxon = Taxon.find(params[:id])
+    @taxon.destroy
+    redirect_to edit_admin_taxonomy_url(@taxon.taxonomy), :notice => "Successfully destroyed taxon."
+  end
+
+
+  # Action for getting the children of a taxon
+  # right now it only responds to json requests
+  def children
+    @taxon = Taxon.find params[:id]
+    @children = @taxon.children
+    @tree = tree_children(@taxon)
+    respond_to do |format|
+      format.html
+      format.json { render :json => @tree }
+    end
+    
+  end
+
+
+  private 
+
+  def find_taxonomy
+    if params[:taxonomy_id]
+      @taxonomy = Taxonomy.find(params[:taxonomy_id]) 
+    else
+      @taxonomy = nil
+    end
+  end
+
+end

data/app/controllers/application_controller.rb

@@ -0,0 +1,3 @@
+class ApplicationController < ActionController::Base
+  protect_from_forgery
+end

data/app/models/taxon.rb

@@ -0,0 +1,62 @@
+class Taxon < ActiveRecord::Base
+
+  acts_as_nested_set :dependent => :destroy
+
+  acts_as_url :name, :sync_url => true
+
+
+  belongs_to :taxonomy
+
+  before_create :set_path, :set_taxonomy
+  after_create :set_root
+  before_update :set_path
+
+
+  # TODO: I don't love this implementation as it doesn't allow for effective navigation up the tree
+  # but it does provide a nice url breadcrumb trail
+
+
+  # Creates path based on .to_url method provided by stringx gem
+  def set_path
+
+    if self.root? 
+      self.path = '/' 
+    else
+      ancestor_path = parent_taxon.path rescue "/"
+      sep = ancestor_path == "/" ? "" : "/"
+      self.path = ancestor_path + sep + self.url
+    end
+
+    #if parent_id.nil?
+    #self.path = self.url if self.path.blank?
+    #else
+    #parent_taxon = Taxon.find(parent_id)
+    #self.path = [parent_taxon.path, (self.path.blank? ? name.to_url : self.path.split("/").last)].join('/')
+    #end
+  end
+
+  def set_taxonomy
+    if ! self.root?
+      self.root_id = parent_taxon.root_id
+      self.taxonomy_id = parent_taxon.taxonomy_id
+    end
+  end
+
+  def set_root
+    self.root_id = self.id if self.root?
+    save
+  end
+
+
+
+  private
+
+  def parent_taxon
+    @parent_taxon ||= Taxon.find(self.parent_id)
+  end
+
+
+
+
+
+end

data/app/models/taxonomy.rb

@@ -0,0 +1,24 @@
+class Taxonomy < ActiveRecord::Base
+  has_many :taxons
+  has_one :root, :class_name => 'Taxon', :conditions => "parent_id is null"
+
+
+  after_create :create_root_taxon
+  before_destroy :delete_taxons
+
+  def create_root_taxon
+    self.taxons.create(:name => self.name + "__root")
+  end
+
+
+  # Doing this through a callback because it doesn't 
+  # rely on the destroy conditions of the taxons and
+  # makes deleting much more efficient
+  def delete_taxons
+    # TODO: More to do here. 
+    # We probably will want to ensure that any items
+    # assigned to the taxons get reassigned or cleaned
+    # up appropriately.
+    Taxon.destroy_all(:taxonomy_id => self.id)
+  end
+end

data/app/views/admin/taxonomies/_form.html.erb

@@ -0,0 +1,4 @@
+<p>
+  <%= f.label :name, t("name") %> <span class="required">*</span><br />
+  <%= text_field :taxonomy, :name  %>
+</p>

data/app/views/admin/taxonomies/_js_head.html.erb

@@ -0,0 +1,9 @@
+<% content_for :head do %>
+  <%= javascript_tag "var taxonomy_id = #{@taxonomy.id};
+    var loading = '#{escape_javascript t('loading')}';
+    var new_taxon = '#{escape_javascript t('new_taxon')}';
+    var server_error = '#{escape_javascript t('server_error')}';
+    var taxonomy_tree_error = '#{escape_javascript t('taxonomy_tree_error')}';"
+  %>
+  <%= javascript_include_tag 'taxonomy', 'jsTree/jquery.jstree.js' %>
+<% end %>

data/app/views/admin/taxonomies/_list.html.erb

@@ -0,0 +1,20 @@
+<table class="index" id='listing_taxonomies'>
+  <tr>
+    <th><%= "Name" %></th>
+    <th>&nbsp;</th>
+  </tr>
+<% for taxonomy in @taxonomies %>
+  <tr id="<%= dom_id taxonomy %>">
+	  <td>
+	    <%= taxonomy.name %>
+    </td>
+    <td class="actions">
+      <%= link_to "Edit", edit_admin_taxonomy_url(taxonomy.id), :class => 'edit' %>
+      &nbsp;
+      <%= link_to "Delete", admin_taxonomy_path(taxonomy), :confirm => 'Are you sure?', :method => :delete %>
+      
+    </td>
+  </tr>
+<% end %>
+</table>
+

data/app/views/admin/taxonomies/edit.erb

@@ -0,0 +1,29 @@
+<%= render :partial => "js_head" %>
+
+<h1><%= t("taxonomy_edit")%></h1>
+
+<p id="ajax_error" class="errorExplanation" style="display:none;"></p>
+
+<%= form_for(:taxon, :url => admin_taxonomy_url, :html => { :method => :put }) do |f| %>
+  <%= render :partial => 'form', :locals => {:f => f} %>
+	  <div>
+	    <label>Taxonomy Tree</label><br />
+      <div id="taxonomy_tree" class="tree"></div>
+  	</div>
+  	<p id="progress" style="display:none;">
+       <%= image_tag('spinner.gif', :alt =>  "Spinner", :style => "vertical-align:bottom") %>
+       <%= t('updating') %>..
+    </p>
+
+	<p class="form-buttons">
+	  <%= f.submit %> <%= link_to "Back to Taxonomies", admin_taxonomies_path %>
+  </p>
+<% end %>
+
+
+<% content_for :head do %>
+  <script type="text/javascript">
+    var initial = <%= raw @tree.to_json %>;
+
+  </script>
+<% end %>

data/app/views/admin/taxonomies/index.html.erb

@@ -0,0 +1,7 @@
+<h1>Taxonomies</h1>
+
+<div id='list-taxonomies'>
+	<%= render :partial => 'list' %>
+</div>
+
+<%= link_to "New Taxonomy", new_admin_taxonomy_url %>

data/app/views/admin/taxonomies/new.html.erb

@@ -0,0 +1,11 @@
+
+<h1><%= t("new_taxonomy") %></h1>
+
+<%= form_for(:taxonomy, :url => '/admin/taxonomies') do |f| %>
+
+	<%= render :partial => "form", :locals => { :f => f } %>
+
+	<p class="form-buttons">
+	  <%= f.submit %> or <%= link_to "Cancel", admin_taxonomies_url %>
+  </p>
+<% end %>