spreadhead 0.6.0

data/lib/spreadhead/page.rb

@@ -0,0 +1,82 @@
+module Spreadhead
+  module Page
+
+    # Hook for all Spreadhead::Page modules.
+    #
+    # If you need to override parts of Spreadhead::Page,
+    # extend and include à la carte.
+    #
+    # @example
+    #   extend ClassMethods
+    #   include InstanceMethods
+    #   include AttrAccessor
+    #   include Callbacks
+    #
+    # @see ClassMethods
+    # @see InstanceMethods
+    # @see Validations
+    # @see Scopes
+    # @see Callbacks
+    def self.included(model)
+      model.extend(ClassMethods)
+      model.send(:include, InstanceMethods)
+      model.send(:include, Validations)
+      model.send(:include, Scopes)
+      model.send(:include, Callbacks)
+    end
+
+    module Validations
+      # Hook for validations.
+      #
+      # :title must be present and unique
+      # :text must be present
+      # :url must be unique
+      def self.included(model)
+        model.class_eval do
+          validates_presence_of :text
+          validates_presence_of :title
+          validates_uniqueness_of :title
+          validates_uniqueness_of :url  
+          validates_presence_of :url  
+        end
+      end
+    end
+
+    module Scopes
+      # Hook for scopes.
+      #
+      # :published should have its own scope
+      def self.included(model)
+        model.class_eval do
+          named_scope :published, :conditions => ['published = ?', true]
+        end
+      end
+    end
+
+    module Callbacks
+      # Hook for callbacks.
+      #
+      # :title should act like a url.
+      def self.included(model)
+        model.class_eval do
+          acts_as_url :title, :sync_url => true, :only_when_blank => true
+        end
+      end
+    end
+
+    module InstanceMethods
+    end  
+
+    module ClassMethods
+      def to_fixtures(path=nil)
+        path ||= File.expand_path("db/data/#{table_name}.yml", RAILS_ROOT)
+        path = File.join(path, "#{table_name}.yml") if File.directory?(path)
+        file = File.open(path, "w")
+        file.puts(self.find(:all).inject({}) { |hash, record| 
+          hash.merge("\"#{record.title}\"" => record.attributes) 
+        }.to_yaml(:SortKeys => true))
+        file.close
+      end
+    end
+  end
+end

data/lib/spreadhead/render.rb

@@ -0,0 +1,35 @@
+require 'redcloth'
+require 'bluecloth'
+
+module Spreadhead
+  module Render
+
+    def self.included(controller) # :nodoc:
+      controller.send(:include, InstanceMethods)
+      controller.class_eval do
+        helper_method :spreadhead
+        hide_action   :spreadhead
+      end
+    end
+
+    module InstanceMethods
+      # Show the contents of the specified page to be used when rendering. The 
+      # page parameter can be either a string (the page url) or a Page object.
+      #
+      # @return The page text as a string
+      def spreadhead(page)
+        return '' unless page
+        page = ::Page.find_by_url!(page) if page.is_a? String
+
+        case page.formatting
+          when 'markdown'
+            BlueCloth.new(page.text).to_html
+          when 'textile'
+            RedCloth.new(page.text).to_html
+          else
+            page.text
+        end        
+      end
+    end  
+  end
+end

data/lib/tasks/spreadhead_tasks.rake

@@ -0,0 +1,16 @@
+require 'active_record/fixtures'    
+
+namespace :spreadhead do
+  desc "Export a set of fixtures from the current database pages"
+  task :export => [:environment] do
+    data = File.join(RAILS_ROOT, 'db', 'data')
+    Dir.mkdir(data) unless File.exists?(data)
+    Page.to_fixtures(data)
+  end
+      
+  desc "Import a set of page fixtures into the current database (overwrites existing pages)"
+  task :import => [:environment] do
+    puts 'Importing fixtures' 
+    Fixtures.create_fixtures("db/data/", 'pages')
+  end
+end

data/rails/init.rb

@@ -0,0 +1 @@
+require 'spreadhead'

data/test/controllers/pages_controller_test.rb

@@ -0,0 +1,118 @@
+require 'test_helper'
+require File.expand_path(File.dirname(__FILE__) + "/../rails/test/factories/spreadhead")
+
+class PagesControllerTest < ActionController::TestCase
+
+  tests Spreadhead::PagesController
+
+  context "default setup" do
+    setup do
+      module Spreadhead::PagesAuth
+        def self.filter(controller); controller.send(:head, 403); end
+      end  
+    end  
+          
+    context "on GET to #new" do
+      setup { get :new }
+      should_respond_with 403
+    end
+    
+    context "on GET to #show" do
+      setup do
+        page = Factory(:page)
+        get :show, :url => page.url
+      end  
+
+      should_respond_with :success
+      should_render_template :show
+      should_not_set_the_flash
+    end
+  end
+
+  context "authorized" do
+    setup do
+      module Spreadhead::PagesAuth
+        def self.filter(controller); true; end
+      end  
+    end  
+      
+    context "on GET to #new" do
+      setup { get :new }
+
+      should_respond_with :success
+      should_render_template :new
+      should_not_set_the_flash
+    end
+
+    context "on GET to #index" do
+      setup { get :index }
+
+      should_respond_with :success
+      should_render_template :index
+      should_not_set_the_flash
+    end
+
+    context "on GET to #show" do
+      setup do
+        page = Factory(:page)
+        get :show, :url => page.url
+      end  
+
+      should_respond_with :success
+      should_render_template :show
+      should_not_set_the_flash
+    end
+
+    context "on GET to #edit" do
+      setup do
+        page = Factory(:page)
+        get :edit, :id => page.id
+      end  
+
+      should_respond_with :success
+      should_render_template :edit
+      should_not_set_the_flash
+    end
+
+    context "on POST to #create with valid attributes" do
+      setup do
+        page_attributes = Factory.attributes_for(:page)
+        post :create, :page => page_attributes
+      end
+        
+      should_respond_with :redirect
+      should_not_set_the_flash
+      should_redirect_to("The list of pages") { pages_url }
+    end
+    
+    context "on PUT to #update with valid attributes" do
+      setup do
+        page = Factory(:page)              
+        put :update, :id => page.id, :page => page.attributes
+      end
+        
+      should_respond_with :redirect
+      should_not_set_the_flash
+      should_redirect_to("The list of pages") { pages_url }
+    end
+    
+    context "on DELETE to #destroy with valid attributes" do
+      setup do
+        page = Factory(:page)
+        delete :destroy, :id => page.id
+      end
+      
+      should_respond_with :redirect
+      should_not_set_the_flash
+      should_redirect_to("The list of pages") { pages_url }
+
+      should "Destroy the page" do
+        count = Page.count
+        page = Factory(:page)
+        delete :destroy, :id => page.id
+        assert_equal Page.count, count
+      end
+
+    end
+  end  
+end

data/test/models/page_test.rb

@@ -0,0 +1,67 @@
+require 'test_helper'
+require File.expand_path(File.dirname(__FILE__) + "/../rails/test/factories/spreadhead")
+
+class PageTest < ActiveSupport::TestCase
+
+  context "When creating a page" do
+    setup { Factory(:page) }
+    
+    should_validate_presence_of :text, :title
+    should_validate_uniqueness_of :title
+
+    should "generate a url" do
+      page = Factory.build(:page, :title => 'smack!')
+      assert page.save
+      assert_not_nil page.url
+      assert_equal 'smack', page.url
+    end
+
+    should "accept a url" do
+      page = Factory.build(:page, :title => 'smackdown!', :url => 'whammo')
+      assert page.save
+      assert_not_nil page.url
+      assert_equal 'whammo', page.url
+    end
+
+    should "not duplicate urls" do
+      page = Factory.build(:page, :title => 'smurf', :url => 'bunnies')
+      assert page.save
+      assert_not_nil page.url
+      assert_equal 'bunnies', page.url
+      page = Factory.build(:page, :title => 'bunnies', :url => nil)
+      assert page.save
+      assert_not_nil page.url
+      assert_not_equal 'bunnies', page.url
+    end
+
+    should "modify the submitted url and be valid if duplicate url is submitted" do
+      page = Factory(:page, :title => 'smurf', :url => 'bunnies')
+      dup = Factory.build(:page, :title => 'smurffette', :url => 'bunnies')
+      assert dup.valid?
+      assert_not_equal page.url, dup.url
+      assert dup.save
+      assert !dup.errors.on(:url)
+    end
+    
+    should "add suffix and be valid when two different titles generate the same url" do
+      page = Factory(:page, :title => 'smurf', :url => 'smurf')
+      dup = Factory(:page, :title => 'smurf!', :url => 'buttons')
+      assert dup.update_attributes(:url => nil)
+      assert_equal 'smurf-1', dup.url
+    end
+    
+    should "be valid when a url is a subset of another url" do
+      page = Factory(:page, :title => 'smurf', :url => 'woozles')
+      dup = Factory(:page, :title => 'Woo', :url => 'brick-spin-brachiosaurus')
+      assert dup.update_attributes(:url => nil)
+      assert_equal 'woo', dup.url
+    end
+
+  end
+  
+  context "When retrieving a page" do
+    setup { Factory(:page) }
+
+    should_have_named_scope :published
+  end
+end

data/test/models/render_test.rb

@@ -0,0 +1,50 @@
+require 'test_helper'
+require File.expand_path(File.dirname(__FILE__) + "/../rails/test/factories/spreadhead")
+
+class Renderer < ApplicationController
+  include Spreadhead::Render
+end
+
+class RenderTest < ActiveSupport::TestCase
+
+  context "When rendering a page" do
+    setup do 
+      @renderer = Renderer.new
+      @page = Factory(:page) 
+    end  
+   
+    should "render a page by url" do
+      assert_equal "Paging Mrs. Smith", @renderer.spreadhead(@page.url)
+    end
+    
+    should "render a page by object" do
+      assert_equal "Paging Mrs. Smith", @renderer.spreadhead(@page)
+    end
+
+    should "render an empty page" do 
+      assert_equal "", @renderer.spreadhead(nil)
+    end
+  end
+      
+  context "When rendering a textile page" do
+    setup do 
+      @renderer = Renderer.new
+      @page = Factory(:page, :text => 'h2. Sunday Sunday Sunday', :formatting => 'textile') 
+    end  
+   
+    should "render a page with textile"  do
+      assert_equal "<h2>Sunday Sunday Sunday</h2>", @renderer.spreadhead(@page)
+    end
+  end  
+      
+  context "When rendering a markdown page" do
+    setup do 
+      @renderer = Renderer.new
+      @page = Factory(:page, :text => "Sunday Sunday Sunday\n---", :formatting => 'markdown') 
+    end  
+   
+    should "render a page with textile"  do
+      assert_equal "<h2>Sunday Sunday Sunday</h2>", @renderer.spreadhead(@page)
+    end
+  end  
+end   

data/test/test_helper.rb

@@ -0,0 +1,4 @@
+require File.expand_path(File.dirname(__FILE__) + "/rails/config/environment")
+require 'test_help'
+require 'factory_girl'
+require 'shoulda'

metadata

@@ -0,0 +1,122 @@
+--- !ruby/object:Gem::Specification 
+name: spreadhead
+version: !ruby/object:Gem::Version 
+  version: 0.6.0
+platform: ruby
+authors: 
+- Jeff Rafter
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2009-08-20 00:00:00 -07:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: BlueCloth
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: RedCloth
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: rsl-stringex
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+    version: 
+description: Rails content mangement for pages that shouldn't be views.
+email: jeff@socialrange.org
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE
+- README.textile
+files: 
+- CHANGELOG.textile
+- LICENSE
+- README.textile
+- Rakefile
+- TODO.textile
+- TUTORIAL.textile
+- VERSION
+- app/controllers/spreadhead/pages_controller.rb
+- app/views/spreadhead/pages/_form.html.erb
+- app/views/spreadhead/pages/edit.html.erb
+- app/views/spreadhead/pages/index.html.erb
+- app/views/spreadhead/pages/new.html.erb
+- app/views/spreadhead/pages/show.html.erb
+- config/spreadhead_routes.rb
+- generators/spreadhead/USAGE
+- generators/spreadhead/lib/insert_commands.rb
+- generators/spreadhead/lib/rake_commands.rb
+- generators/spreadhead/spreadhead_generator.rb
+- generators/spreadhead/templates/README
+- generators/spreadhead/templates/factories.rb
+- generators/spreadhead/templates/initializer.rb
+- generators/spreadhead/templates/migrations/create_pages.rb
+- generators/spreadhead/templates/migrations/update_pages.rb
+- generators/spreadhead/templates/page.rb
+- lib/spreadhead.rb
+- lib/spreadhead/extensions/routes.rb
+- lib/spreadhead/filter.rb
+- lib/spreadhead/page.rb
+- lib/spreadhead/render.rb
+- lib/tasks/spreadhead_tasks.rake
+- rails/init.rb
+- test/controllers/pages_controller_test.rb
+- test/models/page_test.rb
+- test/models/render_test.rb
+- test/test_helper.rb
+has_rdoc: true
+homepage: http://github.com/jeffrafter/spreadhead
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.4
+signing_key: 
+specification_version: 3
+summary: Rails content mangement for pages that shouldn't be views.
+test_files: 
+- test/controllers/pages_controller_test.rb
+- test/models/page_test.rb
+- test/models/render_test.rb
+- test/test_helper.rb