spree_essentials 0.1.0.pre

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/README.md

@@ -0,0 +1,187 @@
+Spree Essentials
+================
+
+Spree Essentials is the base for many content related extensions for Spree. It doesn't do much on it's own ;)
+
+Spree Essentials provides other extensions with:
+
+* An easy markdown editor with ajax preview
+* Image picker for embedding images into markdown editor
+
+Current essential-aware extensions include:
+
+* [spree_essential_cms](https://github.com/citrus/spree_essential_cms): A full featured CMS with pages, contents, images and more
+* [spree_essential_blog](https://github.com/citrus/spree_essential_blog): A blog complete with archives, tags and related products
+* [spree_essential_news](https://github.com/citrus/spree_essential_news): A news system, also complete with archives, tags and related products. (yes it's pretty much the exact same thing as the blog)
+* [spree_essential_press](https://github.com/citrus/spree_essential_press): A simple press page for displaying media related content.
+
+
+
+**ALL OF THESE UNDER DEVELOPMENT**
+
+
+
+Installation
+------------
+
+If you don't already have an existing Spree site, [click here](https://gist.github.com/946719) then come back later... You can also read the Spree docs [here](http://spreecommerce.com/documentation/getting_started.html)...
+
+Spree Essentials hasn't been released to rubygems so you'll have to install it from the source. Just add the following to your Gemfile:
+
+    gem 'spree_essentials', :git => 'git://github.com/citrus/spree_essentials.git'
+  
+    # Add any of the extensions you wish to use
+  
+    gem 'spree_essential_cms', :git => 'git://github.com/citrus/spree_essential_cms.git'
+    gem 'spree_essential_blog', :git => 'git://github.com/citrus/spree_essential_blog.git'
+    
+  
+    
+Then run:
+    
+    bundle install
+
+
+Once that's complete, run the migration generator and migrate your database:
+
+To see your available generators run
+ 
+    rails g
+ 
+    
+Now run the generators for extensions you wish to install    
+ 
+    rails g spree_essentials:install
+    rails g spree_essentials:cms
+    rails g spree_essentials:blog
+ 
+    
+Then migrate your database:
+    rake db:migrate
+
+
+If that all went smoothly, you should be ready to boot the server with:
+
+    rails s
+
+
+Now login to the admin and click on the 'Content' tab!
+
+
+
+Essential Awareness
+-------------------
+
+Spree Essentials is designed to allow other extensions to reside under it's global 'Content' tab in the admin. [SpreeEssentialPress](https://github.com/citrus/spree_essential_press) is the first of many extensions that can run with or without spree_essentials installed.
+
+Setting up an essential aware extension is easy. In your `lib/[extension_name].rb` file, add something like this:
+
+
+    module SpreeEssentialPress
+      
+      def self.tab
+        [:press, { :route => :admin_press_index }]
+      end
+      
+      def self.sub_tab
+        [:press, { :route => :admin_press_index, :label => 'admin.subnav.press', :match_path => '/press' }]
+      end
+      
+      def self.independent?
+        return true unless defined?(SpreeEssentials)
+        !SpreeEssentials.respond_to(:register)
+      end
+    
+    end
+    
+    if SpreeEssentialPress.independent?
+      require 'spree_essential_press/custom_hooks'
+    else 
+      SpreeEssentials.register :press, SpreeEssentialPress 
+    end
+
+
+
+
+Notes
+-----
+
+As I mentioned before, spree_essentials is still being developed... Development is being done on OSX with Ruby 1.9.2 and Spree 0.50.2.
+
+Please let me know of any bugs you find or feature requests you'd like to see. 
+
+
+Testing
+-------
+
+The test suite is very limited at the moment but can be run like so:
+
+    git clone git://github.com/citrus/spree_essentials.git
+    cd spree_essentials
+    bundle install
+    rake db:test_prep
+    rake
+    
+    
+You can also boot spork to run the tests much faster
+
+    # in one window
+    cd spree_essentials
+    spork
+    
+    # in another window
+    testdrb test/**/*_test.rb
+    
+    
+
+
+To Do
+-----
+
+* more tests
+* better documentation
+
+
+
+
+Change Log
+----------
+
+
+**2011/4/26**
+
+* Modularized CMS. It can now be found [here](https://github.com/citrus/spree_essential_cms)
+
+**2011/4/12**
+
+* Added content contexts for multiple contents per page
+* Namespaced posts into blog/posts
+* Added `<!-- more -->` tag to posts
+
+
+**2011/4/4**
+
+* Added Page Images and starting to remove resource_controller.
+
+
+**2011/4/3**
+
+* Automatically adds [Heroku](http://heroku.com) support when you include [spree_heroku](https://github.com/paxer/spree-heroku) in your Gemfile. Check the [spree_heroku readme](https://github.com/paxer/spree-heroku#readme) for full installation instructions.
+* Creates default content when you create a new page.
+
+more in `CHANGELOG.md`
+
+
+Contributors
+------------
+
+So far it's just me; Spencer Steffen. 
+
+If you'd like to help out feel free to fork and send me pull requests!
+
+
+
+License
+-------
+
+Copyright (c) 2011 Spencer Steffen, released under the New BSD License All rights reserved.

data/Rakefile

@@ -0,0 +1,40 @@
+# encoding: UTF-8
+require 'rubygems'
+begin
+  require 'bundler/setup'
+rescue LoadError
+  puts 'You must run `gem install bundler` and `bundle install` to run rake tasks'
+end
+
+require 'rake'
+require 'rake/rdoctask'
+require 'rake/testtask'
+
+Bundler::GemHelper.install_tasks
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'lib'
+  t.libs << 'test'
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = false
+end
+
+namespace :db do
+  desc "preps the test database"
+  task :test_prep do
+    dir = File.expand_path("../test/dummy/db", __FILE__)
+    db  = File.join(dir, "test.sqlite3")
+    File.delete(db) if File.exists?(db)
+    system("cd test/dummy; rake db:migrate RAILS_ENV=test")
+  end
+end
+
+task :default => :test
+
+Rake::RDocTask.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'SpreeEssentials'
+  rdoc.options << '--line-numbers' << '--inline-source'
+  rdoc.rdoc_files.include('README.rdoc')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/app/controllers/admin/markdown_controller.rb

@@ -0,0 +1,7 @@
+class Admin::MarkdownController < Admin::BaseController
+
+  def preview
+    render :text => RDiscount.new(params[:data].to_s).to_html
+  end 
+
+end

data/app/controllers/admin/resource_controller.rb

@@ -0,0 +1,222 @@
+require 'spree_core/action_callbacks'
+
+class Admin::ResourceController < Admin::BaseController
+  helper_method :new_object_url, :edit_object_url, :object_url, :collection_url
+  before_filter :load_resource
+
+  respond_to :html
+  
+  def new
+    render :layout => !request.xhr?
+  end
+  
+  def edit
+    render :layout => !request.xhr?
+  end
+    
+  def update
+    invoke_callbacks(:update, :before)
+    if @object.update_attributes(params[object_name])
+      invoke_callbacks(:update, :after)
+      resource_desc = I18n.t(object_name)
+      resource_desc += " \"#{@object.name}\"" if @object.respond_to?(:name)
+      flash[:notice] = I18n.t(:successfully_updated, :resource => resource_desc)
+      respond_to do |format|
+        format.html { redirect_to location_after_save }
+        format.js   { render :layout => false }      
+      end
+    else
+      invoke_callbacks(:update, :fails)
+      render :edit
+    end
+  end
+
+  def create
+    invoke_callbacks(:create, :before)
+    if @object.save
+      invoke_callbacks(:create, :after)
+      resource_desc = I18n.t(object_name)
+      resource_desc += " \"#{@object.name}\"" if @object.respond_to?(:name)
+      flash[:notice] = I18n.t(:successfully_created, :resource => resource_desc)
+      respond_to do |format|
+        format.html { redirect_to location_after_save }
+        format.js   { render :layout => false }      
+      end
+    else
+      invoke_callbacks(:create, :fails)
+      render :new
+    end
+  end
+  
+  def destroy
+    invoke_callbacks(:destroy, :before)
+    if @object.destroy
+      invoke_callbacks(:destroy, :after)
+      resource_desc = I18n.t(object_name)
+      resource_desc += " \"#{@object.name}\"" if @object.respond_to?(:name)
+      flash[:notice] = I18n.t(:successfully_removed, :resource => resource_desc)
+      respond_to do |format|
+        format.html { redirect_to collection_url }
+        format.js   { render :partial => "/admin/shared/destroy" }
+      end
+    else
+      invoke_callbacks(:destroy, :fails)
+      redirect_to collection_url
+    end
+  end
+ 
+  protected
+
+  class << self
+    attr_accessor :parent_data
+    attr_accessor :callbacks
+  
+    def belongs_to(model_name, options = {})
+      @parent_data ||= {}
+      @parent_data[:model_name] = model_name
+      @parent_data[:model_class] = model_name.to_s.classify.constantize
+      @parent_data[:find_by] = options[:find_by] || :id
+    end
+    
+    def create
+      @callbacks ||= {}
+      @callbacks[:create] ||= Spree::ActionCallbacks.new
+    end
+    
+    def update
+      @callbacks ||= {}
+      @callbacks[:update] ||= Spree::ActionCallbacks.new
+    end
+    
+    def destroy
+      @callbacks ||= {}
+      @callbacks[:destroy] ||= Spree::ActionCallbacks.new
+    end
+  end
+
+  def model_class
+    controller_name.classify.constantize
+  end
+  
+  def object_name
+    controller_name.singularize
+  end
+  
+  def load_resource
+    if member_action?
+      @object ||= load_resource_instance
+      instance_variable_set("@#{object_name}", @object)
+    else
+      @collection ||= collection
+      instance_variable_set("@#{controller_name}", @collection)
+    end
+  end
+  
+  def load_resource_instance
+    if new_actions.include?(params[:action].to_sym)
+      build_resource
+    elsif params[:id]
+      find_resource
+    end
+  end
+
+  def parent_data
+    self.class.parent_data
+  end
+  
+  def parent
+    if parent_data.present?
+      @parent ||= parent_data[:model_class].where(parent_data[:find_by] => params["#{parent_data[:model_name]}_id"]).first
+      instance_variable_set("@#{parent_data[:model_name]}", @parent)
+    else
+      nil
+    end
+  end
+
+  def find_resource
+    if parent_data.present?
+      parent.send(controller_name).find(params[:id])
+    else
+      model_class.find(params[:id])
+    end
+  end
+  
+  def build_resource
+    if parent_data.present?
+      parent.send(controller_name).build(params[object_name])
+    else
+      model_class.new(params[object_name])
+    end
+  end
+  
+  def collection
+    return parent.send(controller_name) if parent_data.present?
+    
+    if model_class.respond_to?(:accessible_by) && !current_ability.has_block?(params[:action], model_class)
+      model_class.accessible_by(current_ability)
+    else
+      model_class.scoped
+    end
+  end
+  
+  def location_after_save
+    collection_url
+  end
+
+  def invoke_callbacks(action, callback_type)
+    callbacks = self.class.callbacks || {}
+    return if callbacks[action].nil?
+    case callback_type.to_sym
+      when :before then callbacks[action].before_methods.each {|method| send method }
+      when :after  then callbacks[action].after_methods.each  {|method| send method }
+      when :fails  then callbacks[action].fails_methods.each  {|method| send method }
+    end
+  end
+
+  # URL helpers
+
+  def new_object_url(options = {})
+    if parent_data.present?
+      new_polymorphic_url([:admin, parent, model_class], options)
+    else
+      new_polymorphic_url([:admin, model_class], options)
+    end
+  end
+  
+  def edit_object_url(object, options = {})
+    if parent_data.present?
+      send "edit_admin_#{parent_data[:model_name]}_#{object_name}_url", parent, object, options
+    else
+      send "edit_admin_#{object_name}_url", object, options
+    end
+  end
+  
+  def object_url(object = nil, options = {})
+    target = object ? object : @object
+    if parent_data.present?
+      send "admin_#{parent_data[:model_name]}_#{object_name}_url", parent, target, options
+    else
+      send "admin_#{object_name}_url", target, options
+    end
+  end
+  
+  def collection_url(options = {})
+    if parent_data.present?
+      polymorphic_url([:admin, parent, model_class], options)
+    else
+      polymorphic_url([:admin, model_class], options)
+    end
+  end
+  
+  def collection_actions
+    [:index]
+  end
+
+  def member_action?
+    !collection_actions.include? params[:action].to_sym
+  end
+
+  def new_actions
+    [:new, :create]
+  end
+end

data/app/controllers/admin/uploads_controller.rb

@@ -0,0 +1,34 @@
+class Admin::UploadsController < Admin::BaseController
+  
+  resource_controller
+
+	index.response do |wants|
+		wants.html { render :template => request.xhr? ? 'admin/uploads/picker' : 'admin/uploads/index', :layout => !request.xhr? }
+  end
+  
+  new_action.response do |wants|
+    wants.html { 
+      render :action => :new, :layout => false
+    }
+  end
+
+	create.response do |wants|
+		wants.html {redirect_to admin_uploads_path}
+  end
+  
+  update.response do |wants|
+    wants.html { redirect_to collection_url }
+  end
+  
+  destroy.success.wants.js { render_js_for_destroy }
+
+  private
+        
+    def collection
+      params[:search] ||= {}
+      params[:search][:meta_sort] ||= "posted_at.desc"
+      @search = end_of_association_chain.metasearch(params[:search])
+      @collection = @search.paginate(:per_page => Spree::Config[:orders_per_page], :page => params[:page])
+    end
+
+end

data/app/helpers/admin/base_helper_decorator.rb

@@ -0,0 +1,18 @@
+Spree::BaseHelper.class_eval do
+   
+  def markdown_helper
+    content_tag('em', :class => 'small') do
+      [ 
+       " ",
+        t('essentials.parsed_with'),
+        link_to("Markdown", "http://daringfireball.net/projects/markdown/basics", :onclick => 'window.open(this.href); return false')
+      ].join(" ").html_safe
+    end
+  end
+      
+  def method_missing(method, *args, &block)
+    return super unless method.to_s =~ /_path$/
+    "/" + method.to_s.sub(/_path$/, '').gsub('_', '-')
+  end
+      
+end

data/app/models/image_decorator.rb

@@ -0,0 +1,7 @@
+Image.class_eval do
+
+  def has_alt?
+    !alt.blank?
+  end
+
+end

data/app/models/upload.rb

@@ -0,0 +1,46 @@
+class Upload < Asset
+  
+  default_scope where(:type => "Upload")
+  
+  validate :no_attachement_errors
+  
+  # Check for spree_heroku
+  #   https://github.com/paxer/spree-heroku
+  #
+  if defined?(SpreeHeroku)
+    has_attached_file :attachment,
+      :styles => Proc.new{ |clip| clip.instance.attachment_sizes },
+      :default_style => :medium,
+      :path => "assets/uploads/:id/:style/:basename.:extension",
+      :storage => "s3",
+      :s3_credentials => "#{Rails.root}/config/s3.yml"
+  else
+    has_attached_file :attachment,
+      :styles => Proc.new{ |clip| clip.instance.attachment_sizes },
+      :default_style => :medium,
+      :url => "/assets/uploads/:id/:style/:basename.:extension",
+      :path => ":rails_root/public/assets/uploads/:id/:style/:basename.:extension"
+  end
+  
+  def image_content?
+    attachment_content_type.match(/\/(jpeg|png|gif|tiff|x-photoshop)/)
+  end
+     
+  def attachment_sizes
+    if image_content?
+      { :mini => '48x48>', :small => '150x150>', :medium => '420x300>', :large => '800x500>' }
+    else
+      {}
+    end
+  end
+  
+  def no_attachement_errors
+    if attachment_file_name.blank? || !attachment.errors.empty?
+      # uncomment this to get rid of the less-than-useful interrim messages
+      errors.clear
+      errors.add :attachment, "Paperclip returned errors for file '#{attachment_file_name}' - check ImageMagick installation or image source file."
+      false
+    end
+  end
+
+end

data/app/validators/datetime_validator.rb

@@ -0,0 +1,6 @@
+class DatetimeValidator < ActiveModel::EachValidator
+  def validate_each(record, attribute, value)    
+    date = DateTime.parse(value.to_s) rescue ArgumentError
+    record.errors.add(attribute, I18n.t(:invalid_date_time, :scope => [:activerecord, :errors, :messages])) if date == ArgumentError
+  end
+end

data/app/views/admin/shared/_contents_sub_menu.html.erb

@@ -0,0 +1,11 @@
+<% content_for :sub_menu do %>
+  <ul id="sub_nav">
+    <%= hook :admin_contents_sub_tabs do %>
+      <%= tab :pages,   :label => 'admin.subnav.pages',  :match_path => '/pages' %>
+      <% SpreeEssentials.essentials.each do |cls| %>
+        <%= tab *cls.sub_tab if defined?(cls.sub_tab) %>
+      <% end %>
+      <%= tab :uploads, :label => 'admin.subnav.uploads' %>
+    <% end %>
+  </ul>
+<% end %>

data/app/views/admin/shared/_contents_tab.html.erb

@@ -0,0 +1,2 @@
+<%= tab *[:pages, :contents, SpreeEssentials.essentials.map{|cls| cls.tab if defined?(cls.tab) }, :uploads, { :label => '.content' }].flatten %>
+

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

@@ -0,0 +1,8 @@
+<p>
+  <%= form.label :attachment %>:<br/>
+  <%= form.file_field :attachment %>
+</p>
+<p>
+  <%= form.label :alt, t('description') %>:<br/>
+  <%= form.text_field :alt %>
+</p>

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

@@ -0,0 +1,18 @@
+<%= render :partial => 'admin/shared/contents_sub_menu' %>
+
+<% if @upload.try(:errors).present? %>
+  <%= render 'shared/error_messages', :target => @upload %>
+<% end %>
+
+<% form_for([:admin, @upload], :url => admin_upload_url(@upload), :html => { :multipart => true }) do |f| %>
+    <p>
+      <%= label_tag ("thumbnail") %>:<br/>
+      <%= link_to(image_tag(@upload.attachment.url(:mini)), @upload.attachment.url(:product)) %>
+    </p>
+    <%= render "form", :form => f %>
+  </table>
+  <p class="form-buttons">
+    <%= button t("update") %>
+    or <%= link_to t("cancel"), admin_uploads_url, :id => "cancel_link" %>
+  </p>
+<% end %>

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

@@ -0,0 +1,50 @@
+<%= render :partial => 'admin/shared/contents_sub_menu' %>
+
+<table class="index">
+	<tr>
+	  <th><%= t("thumbnail") %></th>
+	  <th><%= sort_link @search, :attachment_file_name, t("upload.file_name") %></th>
+	  <th><%= sort_link @search, :description, t("description") %></th>
+	  <th><%= sort_link @search, :attachment_file_size, t("upload.size") %></th>
+	  <th><%= t("action") %></th>
+	</tr>
+ 
+  <% @uploads.each do |upload| %>
+    <tr id="<%= dom_id(upload) %>">
+      <td class="thumbnail">
+        <% if upload.image_content? %>
+          <%= link_to image_tag(upload.attachment.url(:mini)), upload.attachment.url(:large) %>
+        <% end %>
+      </td>
+      <td><%= link_to upload.attachment_file_name, upload.attachment.url(:original) %></td>
+      <td><%= upload.alt %></td>
+      <td><%= upload.attachment_file_size.to_i / 1024 %> kb</td>
+      <td class="actions">
+        <%= link_to_with_icon('edit', t("edit"), edit_admin_upload_url(upload)) %>
+        &nbsp;
+        <%= link_to_delete upload, {:url => admin_upload_url(upload) }%>
+      </td>
+    </tr>
+  <% end %>
+ 
+</table>
+
+<div id="images"></div>
+<br/>
+<p>
+  <%= link_to icon('add') + ' ' + t(".new_upload"), new_admin_upload_url, :id => "new_image_link" %>
+</p>
+
+<% content_for :head do %>
+  <script type="text/javascript">
+    jQuery(document).ready(function(){  
+      
+      jQuery('#new_image_link').click(function(event) { 
+        event.preventDefault();
+        jQuery(this).hide();
+        jQuery.ajax({type: 'GET', url: this.href, data: ({authenticity_token: AUTH_TOKEN}), success: function(r){ jQuery('#images').html(r);} });
+      });
+      
+    });
+  </script>
+<% end %>