ginsu 0.2.0

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2009 [name of plugin creator]
+
+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.textile

@@ -0,0 +1,88 @@
+h1. Ginsu
+
+Rails applications are not always born as Rails applications.  Sometimes graphic designers create web designs using tools like Dreamweaver and then pass them off to software developers for implementation as web applications
+
+But Rails has a different model for a web site than a tool like BBEdit.  Rails thinks in terms of routes that lead to actions that render from templates that can use layouts, but Rapidweaver thinks in terms of pages.  Every page includes the whole layout.
+
+Ginsu manages the transition of a web project, from a static web site to the final implementation as a Rails application.  Ginsu creates hybrid web sites with some sections served as static content and some sections powered by dynamic Rails actions.
+
+h2. The Problem
+
+You work in a high-volume web shop.  Your job is the nerd stuff: programming the dynamic parts of web projects and dealing with site implementation and hosting.  A producer gives you a .zip file and tells you that the deadline to get the site hosted is that afternoon.  The .zip file contains static .html, .css, image and Flash files from a Dreamweaver project that a graphic designer developed.  Then, the punchline: "Only pages X and Y need to be dynamic, leave the rest static.  We're still designing it.  Oh and we'll be updating this part of page X and this part of page Y once a week."
+
+You don't want to work with a graphic designer every week to update your .erb or .haml files because that makes updates very expensive, which is not very agile.  You don't want to configure your web server to serve only a few routes from your Rails app because making changes is hard and so that's also not very agile.  You can't implement a CMS back-end for making it all irrelevant because you work in a high-volume shop and you only have an hour.
+
+You need a way to bring your graphic designer into the agile process, so that you and the designer can both make updates to your respective areas of the project.
+
+h2. The Solution
+
+<pre><code>cd yourapp
+mkdir static</code></pre>
+
+Copy your static web site from your graphic designer into your Rails application's new "static" directory.  If your static web site has a root index file called "index.html", then your Rails app should have a file called "static/index.html".
+
+Configure Ginsu to slice sections of pages from the static web site into partial templates in your Rails application by adding slicing instructions to your config/initializers/ginsu.rb:
+
+<pre><code># Create a 'header' partial by plucking header HTML from static/index.html using a CSS selector.
+ginsu.partials << { :css => 'h3.r a.l', :static => 'index.html', :partial => 'header' }
+
+# Create a 'header' partial by plucking header HTML from static/index.html using an xpath selector.
+ginsu.partials << { partial :xpath => '//h3/a[@class="l"]', :static => 'index.html', :partial => 'header' }
+
+# Just use the 'search' parameter to use either CSS or xpath.
+ginsu.partials << { :search => 'h3.r a.l', :static => 'index.html', :partial => 'header' }
+ginsu.partials << { :search => '//h3/a[@class="m"]', :static => 'index.html', :partial => 'header' }
+
+# Create symbolic links in the public/ directory of the Rails app for selected sections and files.
+ginsu.links << { :static => 'galleries' }
+ginsu.links << { :static => 'events' }
+ginsu.links << { :static => 'holdout.html' }
+</pre></code>
+
+Now when you run:
+
+<pre><code>rake ginsu:slice</code></pre>
+	
+...Ginsu will find the header in your static/index.html file and create a partial in app/views/_header.html.erb with the contents of the HTML element that it locates using your CSS or xpath selector.
+
+Using this technique does not require your graphic designer to make any changes to the Dreamweaver project.  You don't have to tag the section that you want to slice out, you simply describe where it's located and Ginsu will find it and slice it out.  You bring your graphic designers into the agile process by enabling them to update parts of the web site with their tools, without learning Rails.
+
+h2. Installation
+
+Install the Ginsu gem in your Rails application with:
+
+<pre><code>script/plugin install git://github.com/endymion/ginsu.git</code></pre>
+
+Generate your initializer, for configuring Ginsu:
+
+<pre><code>script/generate ginsu</code></pre>
+
+h2. Configure
+
+The Ginsu configuration is in the initializer file config/initializers/ginsu.rb:
+
+<pre><code>require 'ginsu'
+Ginsu::Knife.configure do |ginsu|
+
+	# The default location of the static web site is 'site', but maybe your static
+	# site includes 150 MB worth of Photoshop .psd files and you don't want those
+	# in your Capistrano deployments.  Change the source path here if you want.
+	ginsu.source = '/home/webproject/site'
+
+	ginsu.partials << { :search => '#header', :static => 'index.html', :partial => 'header' }
+	ginsu.partials << { :search => '#footer', :static => 'index.html', :partial => 'footer' }
+
+	ginsu.links << { :static => 'galleries' }
+	ginsu.links << { :static => 'news' }
+
+end</code></pre>
+
+h2. Features
+
+h3. partial
+
+A partial is the content of an HTML element that Ginsu will partial out of a static HTML document and drop into a Rails partial template.
+
+h3. link
+
+A link is a page or a folder that you want to be entirely served as static content.  Ginsu will create symbolic links in your Rails application's public/ directory for each link.

data/Rakefile

@@ -0,0 +1,40 @@
+require 'rake'
+require 'rake/testtask'
+require 'rake/rdoctask'
+
+desc 'Default: run unit tests.'
+task :default => :test
+
+desc 'Test the ginsu plugin.'
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'lib'
+  t.libs << 'test'
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = true
+end
+
+desc 'Generate documentation for the ginsu plugin.'
+Rake::RDocTask.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'Ginsu'
+  rdoc.options << '--line-numbers' << '--inline-source'
+  rdoc.rdoc_files.include('README')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gemspec|
+    gemspec.name = 'ginsu'
+    gemspec.summary = 'A Ruby on Rails plugin for carving partials out of static web sites.'
+    gemspec.email = 'rap@endymion.com'
+    # gemspec.homepage = "http://github.com/technicalpickles/the-perfect-gem"
+    gemspec.description = <<-EOF
+Ginsu is a Ruby on Rails plugin for carving partials out of static web sites, for including
+graphic designers in the agile process for developing a web project.
+EOF
+    gemspec.authors = ["Ryan Porter"]
+  end
+rescue LoadError
+  puts "Jeweler not available. Install it with: sudo gem install technicalpickles-jeweler -s http://gems.github.com"
+end

data/VERSION

@@ -0,0 +1 @@
+0.2.0

data/generators/ginsu/USAGE

@@ -0,0 +1,8 @@
+Description:
+    Generates the Ginsu initializer in config/intitializers/ginsu.rb
+
+Example:
+    ./script/generate ginsu
+
+    This will create:
+        config/initializers/ginsu.rb

data/generators/ginsu/ginsu_generator.rb

@@ -0,0 +1,7 @@
+class GinsuGenerator < Rails::Generator::Base
+  def manifest
+    record do |m|
+      m.template 'config/initializers/ginsu.rb', 'config/initializers/ginsu.rb'
+    end
+  end
+end

data/generators/ginsu/templates/config/initializers/ginsu.rb

@@ -0,0 +1,17 @@
+require 'ginsu'
+Ginsu::Knife.configure do |ginsu|
+
+	# The default location of the static web site is the 'static' folder in your Rails app,
+	# but maybe your static site includes 150 MB worth of Photoshop .psd files and you don't
+	# want those in your Capistrano deployments.  Change the source path here if you want.
+  # ginsu.source = '/home/webproject/site'
+
+  # ginsu.partials << { :static => 'index.html', :partial => 'header', :search => '#header' }
+  # ginsu.partials << { :static => 'index.html', :partial => 'footer', :search => '#footer' }
+
+  # ginsu.templates << { :static => 'Templates/master.dwt', :template => 'master' }
+
+  # ginsu.links << { :static => 'galleries' }
+  # ginsu.links << { :static => 'news' }
+
+end

data/ginsu.gemspec

@@ -0,0 +1,59 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run 'rake gemspec'
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{ginsu}
+  s.version = "0.2.0"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Ryan Porter"]
+  s.date = %q{2011-05-19}
+  s.description = %q{Ginsu is a Ruby on Rails plugin for carving partials out of static web sites, for including
+graphic designers in the agile process for developing a web project.
+}
+  s.email = %q{rap@endymion.com}
+  s.extra_rdoc_files = [
+    "README.textile"
+  ]
+  s.files = [
+    "MIT-LICENSE",
+    "README.textile",
+    "Rakefile",
+    "VERSION",
+    "generators/ginsu/USAGE",
+    "generators/ginsu/ginsu_generator.rb",
+    "generators/ginsu/templates/config/initializers/ginsu.rb",
+    "ginsu.gemspec",
+    "init.rb",
+    "install.rb",
+    "lib/ginsu.rb",
+    "lib/ginsu/config.rb",
+    "lib/ginsu/knife.rb",
+    "lib/this_method.rb",
+    "rails/init.rb",
+    "tasks/ginsu_tasks.rake",
+    "test/ginsu_test.rb",
+    "test/test_helper.rb",
+    "uninstall.rb"
+  ]
+  s.require_paths = ["lib"]
+  s.rubygems_version = %q{1.3.7}
+  s.summary = %q{A Ruby on Rails plugin for carving partials out of static web sites.}
+  s.test_files = [
+    "test/ginsu_test.rb",
+    "test/test_helper.rb"
+  ]
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
+    else
+    end
+  else
+  end
+end
+

data/init.rb

@@ -0,0 +1 @@
+require File.dirname(__FILE__) + "/rails/init"

data/install.rb

@@ -0,0 +1 @@
+# Install hook code here

data/lib/ginsu.rb

@@ -0,0 +1,13 @@
+module Ginsu; end
+
+require('rubygems')
+
+require('hpricot')
+
+def require_local(suffix)
+  require(File.expand_path(File.join(File.dirname(__FILE__), suffix)))
+end
+
+require_local('this_method')
+require_local('ginsu/knife')
+require_local('ginsu/config')

data/lib/ginsu/config.rb

@@ -0,0 +1,47 @@
+# config.rb contains classes, methods and extends existing Ginsu classes 
+# to provide easy configuration facilities.
+
+module Ginsu
+  # Represents global configuration for Ginsu::Knife.
+  # Can override the following configuration options:
+  # * <tt>source</tt> - the source directory of the static web site.  Defaults to 'static'.
+  class Config
+    @@ATTRIBUTES = [
+      :source,
+      :partials,
+      :pages,
+      :templates,
+      :links,
+      :folders
+    ]
+    attr_accessor *@@ATTRIBUTES
+
+    def initialize(params = {})
+      params.each do |key,val|
+        self.send("#{key}=", val) if self.respond_to? key
+      end
+      self.send(:init) if self.respond_to? :init
+    end
+    
+  end
+
+  class Knife
+    @@defaults = { 
+      :source => 'static',
+      :partials => [],
+      :pages => [],
+      :templates => [],
+      :links => [],
+      :folders => []
+    }
+    @@config = Ginsu::Config.new(@@defaults)
+
+    class << self
+      # Yields to given <tt>block</tt> to configure the Ginsu.
+      def configure(&block)
+        raise ArgumentError, "Block must be provided to configure" unless block_given?
+        yield @@config
+      end
+    end
+  end
+end

data/lib/ginsu/knife.rb

@@ -0,0 +1,145 @@
+module Ginsu
+  class Knife
+
+    def self.slice
+      self.partials
+      self.pages
+      self.templates
+      self.links
+      self.folders
+    end
+
+    def self.pages parameters=nil
+      files = (parameters and parameters[:partials]) ? @@config.partials : @@config.pages
+      files.each do |file|
+
+        # These should probably raise errors.
+        puts "Error: Each file requires a :static parameter to specify the source file." if
+          file[:static].blank?
+        puts "Error: Each file requires a :search parameter with a search string." if
+          file[:search].blank?
+        puts "Error: Each file requires a :partial parameter with the name of the destination template." if
+          file[:partial].blank?
+
+        # Open the static source HTML file.
+        static_source_string = ''
+        static_source_path = File.join(@@config.source, file[:static])
+        File.open(static_source_path, "r") { |f|
+          static_source_string = ''
+          # Run a proc on each line?
+          if file[:do]
+            f.each {|line| static_source_string << file[:do].call(line)}
+          else
+            static_source_string = f.read
+          end
+        }
+        static_source = Hpricot(static_source_string)
+
+        # Use Hpricot to slice out the desired element.
+        found = static_source.search(file[:search]).first
+
+        # Make sure that the target folder exists.
+        unless File.exists?(target_folder = File.join('app/views/', File.dirname(file[:partial])))
+          Dir.mkdir(target_folder)
+        end
+
+        # Drop that found string into the appropriate partial.
+        target_filename = file[:partial]
+        puts "Slicing '#{target_filename}' from '#{static_source_path}'..."
+        target_filename.gsub!(/\/([^\_][^\/]+$)/) {|string| '/_' + $1 } if
+          parameters and parameters[:partials]
+        target_filename += '.html.erb' unless target_filename =~ /\./
+        target_filename = File.join('app/views/', target_filename)
+        File.open(target_filename, 'w') do |f|
+          f.write(found)
+        end
+        
+      end
+    end
+
+    def self.partials
+      self.pages :partials => true
+    end
+     
+    def self.templates parameters=nil
+      files = @@config.templates
+      files.each do |file|
+
+        # These should probably raise errors.
+        puts "Error: Each file requires a :static parameter to specify the source file." if
+          file[:static].blank?
+        puts "Error: Each file requires a :search parameter with a search string." if
+          file[:search].blank?
+        puts "Error: Each file requires a :template parameter with the name of the destination template." if
+          file[:template].blank?
+
+        # Open the static source HTML file.
+        static_source_string = ''
+        static_source_path = File.join(@@config.source, file[:static])
+        File.open(static_source_path, "r") { |f|
+          static_source_string = ''
+          # Run a proc on each line?
+          if file[:do]
+            f.each {|line| static_source_string << file[:do].call(line)}
+          else
+            static_source_string = f.read
+          end
+        }
+        static_source = Hpricot(static_source_string)
+
+        # Use Hpricot to replace the desired element.
+        static_source.at(file[:search]).swap(file[:replace])
+        found = static_source.to_original_html
+
+        # Drop that found string into the appropriate partial.
+        target_filename = file[:template]
+        puts "Slicing template '#{target_filename}' from '#{static_source_path}'..."
+        target_filename += '.html.erb' unless target_filename =~ /\./
+        target_filename = File.join('app/views/layouts', target_filename)
+        File.open(target_filename, 'w') do |f|
+          f.write(found)
+        end
+        
+      end
+    end
+  
+    def self.links
+      @@config.links.each do |link|
+
+        source = File.join(FileUtils.pwd, @@config.source, link[:static])
+        destination = File.join('public', link[:static])
+
+        puts "Linking '#{source}' to '#{destination}'..."
+
+        puts "Each link requires a :static parameter with the name of the static resource" +
+             "    to link to the public/ directory in your Rails application." if
+             link[:static].blank?
+
+        FileUtils.ln_s source, destination, :force => true unless File.exists? destination
+        
+      end
+    end
+
+    def self.folders
+      @@config.folders.each do |folder|
+
+        source = File.join(FileUtils.pwd, @@config.source, folder[:static])
+        destination = File.join('public', folder[:static])
+
+        puts "Purging '#{destination}'..."
+
+        FileUtils.rm_rf destination
+        
+        puts "Recursively copying '#{source}' to '#{destination}'..."
+
+        puts "Each folder requires a :static parameter with the name of the static resource" +
+             "    to copy to the public/ directory in your Rails application." if
+             folder[:static].blank?
+
+        FileUtils.cp_r source, destination
+        
+      end
+    end
+
+  end
+end

data/lib/this_method.rb

@@ -0,0 +1,6 @@
+module Kernel
+private
+   def this_method
+     caller[0] =~ /`([^']*)'/ and $1
+   end
+end

data/rails/init.rb

@@ -0,0 +1 @@
+# Include hook code here

data/tasks/ginsu_tasks.rake

@@ -0,0 +1,6 @@
+namespace :ginsu do
+  desc "Update Rails application from static web site source."
+  task :slice => :environment do
+    Ginsu::Knife.slice
+  end
+end

data/test/ginsu_test.rb

@@ -0,0 +1,8 @@
+require 'test_helper'
+
+class GinsuTest < ActiveSupport::TestCase
+  # Replace this with your real tests.
+  test "the truth" do
+    assert true
+  end
+end

data/test/test_helper.rb

@@ -0,0 +1,3 @@
+require 'rubygems'
+require 'active_support'
+require 'active_support/test_case'

data/uninstall.rb

@@ -0,0 +1 @@
+# Uninstall hook code here

metadata

@@ -0,0 +1,89 @@
+--- !ruby/object:Gem::Specification 
+name: ginsu
+version: !ruby/object:Gem::Version 
+  hash: 23
+  prerelease: false
+  segments: 
+  - 0
+  - 2
+  - 0
+  version: 0.2.0
+platform: ruby
+authors: 
+- Ryan Porter
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-05-19 00:00:00 -04:00
+default_executable: 
+dependencies: []
+
+description: |
+  Ginsu is a Ruby on Rails plugin for carving partials out of static web sites, for including
+  graphic designers in the agile process for developing a web project.
+
+email: rap@endymion.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- README.textile
+files: 
+- MIT-LICENSE
+- README.textile
+- Rakefile
+- VERSION
+- generators/ginsu/USAGE
+- generators/ginsu/ginsu_generator.rb
+- generators/ginsu/templates/config/initializers/ginsu.rb
+- ginsu.gemspec
+- init.rb
+- install.rb
+- lib/ginsu.rb
+- lib/ginsu/config.rb
+- lib/ginsu/knife.rb
+- lib/this_method.rb
+- rails/init.rb
+- tasks/ginsu_tasks.rake
+- test/ginsu_test.rb
+- test/test_helper.rb
+- uninstall.rb
+has_rdoc: true
+homepage: 
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.7
+signing_key: 
+specification_version: 3
+summary: A Ruby on Rails plugin for carving partials out of static web sites.
+test_files: 
+- test/ginsu_test.rb
+- test/test_helper.rb