spree_snippets 0.5.0

data/LICENSE

@@ -0,0 +1,23 @@
+Redistribution and use in source and binary forms, with or without modification, 
+are permitted provided that the following conditions are met:
+
+    * Redistributions of source code must retain the above copyright notice, 
+      this list of conditions and the following disclaimer.
+    * Redistributions in binary form must reproduce the above copyright notice, 
+      this list of conditions and the following disclaimer in the documentation 
+      and/or other materials provided with the distribution.
+    * Neither the name of the Rails Dog LLC nor the names of its 
+      contributors may be used to endorse or promote products derived from this 
+      software without specific prior written permission.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
+"AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
+LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
+A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR
+CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
+EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
+PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
+PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
+LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
+NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
+SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

data/app/controllers/admin/snippets_controller.rb

@@ -0,0 +1,25 @@
+class Admin::SnippetsController < Admin::BaseController
+  resource_controller
+
+  def create_draft
+    @snippet = Snippet.create!
+    redirect_to edit_admin_snippet_url(@snippet.id)
+  end
+
+  update.response do |wants|
+    wants.html { redirect_to collection_url }
+  end
+
+  update.after do
+    Rails.cache.delete('snippets')
+  end
+
+  create.response do |wants|
+    wants.html { redirect_to collection_url }
+  end
+
+  create.after do
+    Rails.cache.delete('snippets')
+  end
+
+end

data/app/controllers/spree/base_controller_decorator.rb

@@ -0,0 +1,45 @@
+ActionController::Base.class_eval do
+  include ActionView::Helpers::RawOutputHelper
+
+  helper_method :render_snippet
+
+  # snippet can be something that responds to "slug" and "content", 
+  # or a slug, or an id
+  def render_snippet(snippet)
+    if snippet.respond_to?('content')  
+      @snippet = snippet
+    elsif snippet.kind_of?(Fixnum)
+      @snippet = Snippet.find(snippet)
+    elsif snippet.kind_of?(String)
+      @snippet = Snippet.find_by_slug(snippet)
+    else
+      raise "Unable to handle snippet '#{snippet}'"
+    end 
+
+    if Spree::Config[:spree_snippets_raise_on_missing] == "t" && @snippet.nil? 
+	    raise "Snippet '#{snippet}' not found"
+    end
+    return nil unless @snippet
+
+    template = ERB.new File.read(File.expand_path(snippet_wrapper_absolute_path))
+    raw template.result(binding)
+  end
+
+  private
+
+  # Returns the location of the snippet wrapper, which is dependent on how spree is installed.
+  def snippet_wrapper_absolute_path
+    engine_path = File.join(File.dirname(__FILE__), '..', '..', '..')
+
+    [Rails.root, engine_path].each do |root|
+      absolute_path = File.join(root, snippet_wrapper_path)
+      return absolute_path if File.exists?(absolute_path)
+    end
+    raise "Unable to find snippet wrapper using path '#{snippet_wrapper_path}'"
+  end
+
+  # Override the location returned by this method if you want your own snippet wrapper template
+  def snippet_wrapper_path
+    'app/views/snippets/_snippet.html.erb'
+  end
+end

data/app/helpers/admin/snippets_helper.rb

@@ -0,0 +1,2 @@
+module Admin::SnippetsHelper
+end

data/app/helpers/snippet_helper.rb

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

data/app/models/snippet.rb

@@ -0,0 +1,3 @@
+class Snippet < ActiveRecord::Base
+  validates_uniqueness_of :slug, :allow_blank => true
+end

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

@@ -0,0 +1,28 @@
+<style type="text/css" media="screen">
+	.snippet-form-bottom-buttons {
+		margin-left: 5px;
+		margin-bottom: 20px;
+	}
+</style>
+
+<table class="admin-report" width="545">
+  <tr>
+    <td valign="top"><%=t("snippets_slug")%>:</td>
+    <td><%= f.text_field :slug, {"style" => "width: 745px"} %></td>
+  </tr>
+  <tr>
+		<td colspan="2">
+			<%= f.text_area :content, {"style" => "width:100%", "id" => "snippet_content"} %>
+		</td>
+  </tr>
+</table>
+
+<div class="snippet-form snippet-form-bottom-buttons">
+	<div class="button" id="snippet_content_switch_simple">
+		<a href="#"><%= t("editor.switch_simple") %></a>
+	</div>
+	<div class="button" id="snippet_content_switch_rich" style="display: none;">
+		<a href="#"><%= t("editor.switch_rich") %></a>
+	</div>
+</div>
+

data/app/views/admin/snippets/edit.html.erb

@@ -0,0 +1,13 @@
+<%= render :partial => 'admin/shared/configuration_menu' %>
+
+<h1><%= t("editing_snippet") %></h1>
+
+<%= render "shared/error_messages", :target => @snippet %>
+
+<% form_for(:snippet, :url => object_url, :html => { :method => :put }) do |f| %>
+  <%= render :partial => "form", :locals => { :f => f } %>
+	<p class="form-buttons">
+    <%= button t("actions.update"), nil, 'submit' %>
+    <%= t("or") %> <%= link_to t("actions.cancel"), collection_url %>
+  </p>
+<% end %>

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

@@ -0,0 +1,32 @@
+<%= render :partial => 'admin/shared/configuration_menu' %>
+
+<div class='toolbar'>
+  <ul class='actions'>
+    <li id="new_product_link">
+      <%= button_link_to t("new_snippet"), create_draft_admin_snippets_url, {:icon => 'add'} %>
+    </li>
+  </ul>
+  <br class='clear' />
+</div>
+
+<h1><%=t("snippets") %></h1>
+
+<table class="index">
+	<tr>
+		<th><%=t("snippets_slug")%></th>
+		<th><%=t("action")%></th>
+  </tr>
+	<tbody>
+    	<% @snippets.each do |snippet| %>
+		<tr class="<%= cycle('even', 'odd') %>" id="<%= dom_id snippet %>">
+			<td>
+				<%= snippet.slug %>
+			</td>
+			<td>
+        <%= link_to_edit snippet %> &nbsp;
+        <%= link_to_delete snippet %>
+	    </td>
+		</tr>
+		<% end %>
+	</tbody>
+</table>

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

@@ -0,0 +1,13 @@
+<%= render :partial => 'admin/shared/configuration_menu' %>
+
+<h1><%= t("new_snippet") %></h1>
+
+<%= render "shared/error_messages", :target => @snippet %>
+
+<% form_for(:snippet, :url => collection_url) do |f| %>
+  <%= render :partial => "form", :locals => { :f => f } %>
+	<p class="form-buttons">
+    <%= button t("actions.create"), nil, 'submit' %>
+    <%= t("or") %> <%= link_to t("actions.cancel"), collection_url %>
+  </p>
+<% end %>

data/app/views/snippets/_snippet.html.erb

@@ -0,0 +1 @@
+<div id="snippet_<%=@snippet.id%>"><%= @snippet.content %></div>

data/lib/spree_snippets.rb

@@ -0,0 +1,17 @@
+require 'spree_core'
+require 'spree_snippets_hooks'
+
+module SpreeSnippets
+  class Engine < Rails::Engine
+
+    config.autoload_paths += %W(#{config.root}/lib)
+
+    def self.activate
+      Dir.glob(File.join(File.dirname(__FILE__), "../app/**/*_decorator*.rb")) do |c|
+        Rails.env.production? ? require(c) : load(c)
+      end
+    end
+
+    config.to_prepare &method(:activate).to_proc
+  end
+end

data/lib/spree_snippets_hooks.rb

@@ -0,0 +1,5 @@
+class SpreeSnippetsHooks < Spree::ThemeSupport::HookListener
+  insert_after :admin_tabs do
+    %(<%= tab(:snippets) %>)
+  end
+end

data/lib/tasks/install.rake

@@ -0,0 +1,27 @@
+namespace :spree_snippets do
+  desc "Copies all migrations and assets (NOTE: This will be obsolete with Rails 3.1)"
+  task :install do
+    Rake::Task['spree_snippets:install:migrations'].invoke
+    # Not needed yet
+    # Rake::Task['spree_snippets:install:assets'].invoke
+  end
+
+  namespace :install do
+    desc "Copies all migrations (NOTE: This will be obsolete with Rails 3.1)"
+    task :migrations do
+      source = File.join(File.dirname(__FILE__), '..', '..', 'db')
+      destination = File.join(Rails.root, 'db')
+      puts "INFO: Mirroring assets from #{source} to #{destination}"
+      Spree::FileUtilz.mirror_files(source, destination)
+    end
+
+    desc "Copies all assets (NOTE: This will be obsolete with Rails 3.1)"
+    task :assets do
+      source = File.join(File.dirname(__FILE__), '..', '..', 'public')
+      destination = File.join(Rails.root, 'public')
+      puts "INFO: Mirroring assets from #{source} to #{destination}"
+      Spree::FileUtilz.mirror_files(source, destination)
+    end
+  end
+
+end

data/lib/tasks/spree_snippets.rake

@@ -0,0 +1 @@
+# add custom rake tasks here

metadata

@@ -0,0 +1,94 @@
+--- !ruby/object:Gem::Specification 
+name: spree_snippets
+version: !ruby/object:Gem::Version 
+  prerelease: 
+  version: 0.5.0
+platform: ruby
+authors: 
+- Christopher Maujean
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-04-05 00:00:00 -07:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: spree_core
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 0.30.0
+  type: :runtime
+  prerelease: false
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: spree_editor
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+  type: :runtime
+  prerelease: false
+  version_requirements: *id002
+description: 
+email: cmaujean@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- LICENSE
+- lib/spree_snippets.rb
+- lib/spree_snippets_hooks.rb
+- lib/tasks/install.rake
+- lib/tasks/spree_snippets.rake
+- app/controllers/admin/snippets_controller.rb
+- app/controllers/spree/base_controller_decorator.rb
+- app/helpers/admin/snippets_helper.rb
+- app/helpers/snippet_helper.rb
+- app/models/snippet.rb
+- app/views/admin/snippets/_form.html.erb
+- app/views/admin/snippets/edit.html.erb
+- app/views/admin/snippets/index.html.erb
+- app/views/admin/snippets/new.html.erb
+- app/views/snippets/_snippet.html.erb
+has_rdoc: true
+homepage: http://github.com/cmaujean/spree-snippets
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: 1.8.7
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: -51902383
+      segments: 
+      - 0
+      version: "0"
+requirements: 
+- none
+rubyforge_project: spree_snippets
+rubygems_version: 1.6.2
+signing_key: 
+specification_version: 3
+summary: Admin configurable static content for CMS control over specific sections of a view
+test_files: []
+