endymion-ginsu 0.0.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,77 @@
+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
+
+	cd yourapp
+	mkdir static
+
+Copy your static web 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.
+slice :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.
+slice :xpath => '//h3/a[@class="l"]', :static => 'index.html', :partial => 'header'
+
+# Just use the 'search' parameter to use either CSS or xpath.
+slice :search => 'h3.r a.l', :static => 'index.html', :partial => 'header'
+slice :search => '//h3/a[@class="m"]', :static => 'index.html', :partial => 'header'</pre></code>
+
+Now when you run:
+
+	rake ginsu:update
+	
+...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.
+
+h2. Installation
+
+Install the Ginsu gem in your Rails application by adding this to your config/environment.rb:
+
+    config.gem "endymion-ginsu",
+      :lib     => 'ginsu',
+      :source  => 'http://gems.github.com',
+      :version => '>=0.0.0'
+
+Make sure that you have the gem:
+
+    rake gems:install
+
+Create your initializer, for configuring Ginsu:
+
+	rake ginsu:setup
+
+Optionally, you can vendor the gem:
+
+    rake gems:unpack
+
+h2. Configure
+
+The Ginsu configuration is in the initializer file config/initializers/ginsu.rb:
+
+h2. Features
+
+h3. slice
+
+A slice is the content of an HTML element that Ginsu will slice 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.0.0

data/ginsu.gemspec

@@ -0,0 +1,48 @@
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{ginsu}
+  s.version = "0.0.0"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Ryan Porter"]
+  s.date = %q{2009-05-22}
+  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",
+     "ginsu.gemspec",
+     "init.rb",
+     "install.rb",
+     "lib/ginsu.rb",
+     "tasks/ginsu_tasks.rake",
+     "test/ginsu_test.rb",
+     "test/test_helper.rb",
+     "uninstall.rb"
+  ]
+  s.has_rdoc = true
+  s.rdoc_options = ["--charset=UTF-8"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = %q{1.3.1}
+  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 = 2
+
+    if Gem::Version.new(Gem::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
+    else
+    end
+  else
+  end
+end

data/init.rb

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

data/install.rb

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

data/lib/ginsu.rb

@@ -0,0 +1 @@
+# Ginsu

data/tasks/ginsu_tasks.rake

@@ -0,0 +1,4 @@
+# desc "Explaining what the task does"
+# task :ginsu do
+#   # Task goes here
+# 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,65 @@
+--- !ruby/object:Gem::Specification 
+name: endymion-ginsu
+version: !ruby/object:Gem::Version 
+  version: 0.0.0
+platform: ruby
+authors: 
+- Ryan Porter
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2009-05-22 00:00:00 -07: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
+- ginsu.gemspec
+- init.rb
+- install.rb
+- lib/ginsu.rb
+- tasks/ginsu_tasks.rake
+- test/ginsu_test.rb
+- test/test_helper.rb
+- uninstall.rb
+has_rdoc: true
+homepage: 
+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.2.0
+signing_key: 
+specification_version: 2
+summary: A Ruby on Rails plugin for carving partials out of static web sites.
+test_files: 
+- test/ginsu_test.rb
+- test/test_helper.rb