endymion-ginsu 0.0.0 → 0.1.0

data/README

@@ -0,0 +1,13 @@
+Ginsu
+=====
+
+Introduction goes here.
+
+
+Example
+=======
+
+Example goes here.
+
+
+Copyright (c) 2009 [name of plugin creator], released under the MIT license

data/README.textile

@@ -24,22 +24,28 @@ Copy your static web into your Rails application's new "static" directory.  If y
 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'
+configure.slices << { :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'
+configure.slices << { 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>
+configure.slices << { :search => 'h3.r a.l', :static => 'index.html', :partial => 'header' }
+configure.slices << { :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.
+configure.links << { :static => 'galleries' }
+configure.links << { :static => 'events' }
+configure.links << { :static => 'holdout.html' }
+</pre></code>
 
 Now when you run:
 
-	rake ginsu:update
+	rake ginsu:slice
 	
 ...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.
+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
 
@@ -54,9 +60,9 @@ Make sure that you have the gem:
 
     rake gems:install
 
-Create your initializer, for configuring Ginsu:
+Generate your initializer, for configuring Ginsu:
 
-	rake ginsu:setup
+	script/generate ginsu
 
 Optionally, you can vendor the gem:
 
@@ -66,6 +72,22 @@ h2. Configure
 
 The Ginsu configuration is in the initializer file config/initializers/ginsu.rb:
 
+<pre><code>require 'ginsu'
+Ginsu::Knife.configure do |configure|
+
+	# 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.
+	config.source = '/home/webproject/site'
+
+	config.slices << { :search => '#header', :static => 'index.html', :partial => 'header' }
+	config.slices << { :search => '#footer', :static => 'index.html', :partial => 'footer' }
+
+	config.links << { :static => 'galleries' }
+	config.links << { :static => 'news' }
+
+end</code></pre>
+
 h2. Features
 
 h3. slice
@@ -74,4 +96,4 @@ A slice is the content of an HTML element that Ginsu will slice out of a static
 
 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.
+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/VERSION

@@ -1 +1 @@
-0.0.0
+0.1.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,15 @@
+require 'ginsu'
+Ginsu::Knife.configure do |configure|
+
+	# 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.
+  # config.source = '/home/webproject/site'
+
+  # config.slices << { :search => '#header', :static => 'index.html', :partial => 'header' }
+  # config.slices << { :search => '#footer', :static => 'index.html', :partial => 'footer' }
+
+  # config.links << { :static => 'galleries' }
+  # config.links << { :static => 'news' }
+
+end

data/ginsu.gemspec

@@ -2,7 +2,7 @@
 
 Gem::Specification.new do |s|
   s.name = %q{ginsu}
-  s.version = "0.0.0"
+  s.version = "0.1.0"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Ryan Porter"]
@@ -10,17 +10,24 @@ Gem::Specification.new do |s|
   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"
+    "README",
+     "README.textile"
   ]
   s.files = [
     "MIT-LICENSE",
+     "README",
      "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",
      "tasks/ginsu_tasks.rake",
      "test/ginsu_test.rb",
      "test/test_helper.rb",

data/lib/ginsu.rb

@@ -1 +1,12 @@
-# Ginsu
+module Ginsu; end
+
+require('rubygems')
+
+require('nokogiri')
+
+def require_local(suffix)
+  require(File.expand_path(File.join(File.dirname(__FILE__), suffix)))
+end
+
+require_local('ginsu/knife')
+require_local('ginsu/config')

data/lib/ginsu/config.rb

@@ -0,0 +1,41 @@
+# 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,
+      :slices,
+      :links
+    ]
+    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',
+      :slices => [],
+      :links => []
+    }
+    @@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,62 @@
+require 'nokogiri'
+
+module Ginsu
+  class Knife
+
+    def self.slice
+      @@config.slices.each do |slice|
+        
+        puts "Each slice requires a :static parameter to specify the source file." if
+          slice[:static].blank?
+        puts "Each slice requires either a :search, :css or :xpath parameter with a search string." if
+          slice[:css].blank? and slice[:xpath].blank? and slice[:search].blank?
+        puts "Each slice requires a :partial parameter with the name of the destination template." if
+          slice[:partial].blank?
+
+        # Open the static source HTML file.
+        static_source_string = ''
+        static_source_path = File.join(@@config.source, slice[:static])
+        File.open(static_source_path, "r") { |f|
+            static_source_string = f.read
+        }
+        static_source = Nokogiri::HTML(static_source_string)
+
+        # Use Nokogiri to slice out the desired element's content.
+        found = ''
+        if slice[:css]
+          found = static_source.css(slice[:css]).first
+        elsif slice[:xpath]
+          found = static_source.css(slice[:xpath]).first
+        else
+          found = static_source.search(slice[:search]).first
+        end
+        
+        # Drop that found string into the appropriate partial.
+        partial_filename = slice[:partial]
+        partial_filename = '_' + partial_filename unless partial_filename =~ /^[^\_]/
+        partial_filename += '.html.erb' unless partial_filename =~ /\./
+        partial_filename = File.join('app/views/', partial_filename)
+        puts "Sliced partial '#{partial_filename}' from static '#{static_source_path}'."
+        File.open(partial_filename, 'w') {|f| f.write(found) }
+        
+      end
+    end
+  
+    def self.link
+      @@config.links.each do |link|
+        
+        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?
+        
+        source = File.join(FileUtils.pwd, @@config.source, link[:static])
+        destination = File.join('public', link[:static])
+        
+        puts "Linking '#{source}' to '#{destination}'."
+        FileUtils.ln_s source, destination, :force => true
+        
+      end
+    end
+  
+  end
+end

data/tasks/ginsu_tasks.rake

@@ -1,4 +1,7 @@
-# desc "Explaining what the task does"
-# task :ginsu do
-#   # Task goes here
-# end
+namespace :ginsu do
+  desc "Update Rails application from static web site source."
+  task :slice => :environment do
+    Ginsu::Knife.link
+    Ginsu::Knife.slice
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: endymion-ginsu
 version: !ruby/object:Gem::Version 
-  version: 0.0.0
+  version: 0.1.0
 platform: ruby
 authors: 
 - Ryan Porter
@@ -20,16 +20,23 @@ executables: []
 extensions: []
 
 extra_rdoc_files: 
+- README
 - README.textile
 files: 
 - MIT-LICENSE
+- README
 - 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
 - tasks/ginsu_tasks.rake
 - test/ginsu_test.rb
 - test/test_helper.rb