RubyGems - ichiban - Versions diffs - 1.0.0 → 1.0.6 - Mend

ichiban 1.0.0 → 1.0.6

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (34) hide show

data/bin/ichiban +9 -0
data/empty_project/Capfile +19 -0
data/empty_project/assets/css/screen.scss +1 -0
data/empty_project/assets/js/interaction.js +1 -0
data/empty_project/assets/misc/readme.txt +6 -0
data/empty_project/compiled/css/screen.css +1 -0
data/empty_project/compiled/index.html +12 -0
data/empty_project/compiled/js/interaction.js +1 -0
data/empty_project/config.rb +3 -0
data/empty_project/data/readme.txt +2 -0
data/empty_project/helpers/readme.txt +10 -0
data/empty_project/html/index.html +3 -0
data/empty_project/layouts/default.html +12 -0
data/empty_project/models/readme.txt +3 -0
data/empty_project/scripts/readme.txt +6 -0
data/empty_project/webserver/htaccess.txt +24 -0
data/lib/ichiban/asset_compiler.rb +21 -0
data/lib/ichiban/bundle.rb +7 -0
data/lib/ichiban/command.rb +13 -3
data/lib/ichiban/config.rb +2 -2
data/lib/ichiban/deleter.rb +4 -7
data/lib/ichiban/dependencies.rb +28 -7
data/lib/ichiban/file.rb +122 -17
data/lib/ichiban/helpers.rb +16 -47
data/lib/ichiban/html_compiler.rb +62 -12
data/lib/ichiban/loader.rb +53 -0
data/lib/ichiban/logger.rb +37 -3
data/lib/ichiban/markdown.rb +11 -2
data/lib/ichiban/nav_helper.rb +175 -0
data/lib/ichiban/project_generator.rb +16 -0
data/lib/ichiban/scripts.rb +91 -0
data/lib/ichiban/watcher.rb +36 -19
data/lib/ichiban.rb +16 -4
metadata +54 -4

data/bin/ichiban ADDED Viewed

@@ -0,0 +1,9 @@
+#!/usr/bin/env ruby
+# for dev purposes:
+#$:.unshift File.expand_path(File.join(File.dirname(__FILE__), '../lib'))
+require 'rubygems'
+require 'ichiban'
+Ichiban::Command.new(ARGV).run

data/empty_project/Capfile ADDED Viewed

@@ -0,0 +1,19 @@
+load 'deploy'
+set :scm, :git # Or: `accurev`, `bzr`, `cvs`, `darcs`, `git`, `mercurial`, `perforce`, `subversion` or `none`
+set :repository, 'ssh://user@example.com/my_site.git'
+set :branch, 'master'
+set :keep_releases, 2
+set :deploy_via, :remote_cache
+role :web, 'example.com'
+set :user, 'username'
+set :use_sudo, false
+set :deploy_to, '/home/username/my_site'
+namespace :deploy do
+	task(:restart) {}
+end
+set :keep_releases, 2
+after "deploy:update", "deploy:cleanup"

data/empty_project/assets/css/screen.scss ADDED Viewed

	@@ -0,0 +1 @@
1	+ body {font-family: sans-serif;}

data/empty_project/assets/js/interaction.js ADDED Viewed

	@@ -0,0 +1 @@
1	+ // Nothing here yet. This JS file is referenced from the default layout.

data/empty_project/assets/misc/readme.txt ADDED Viewed

@@ -0,0 +1,6 @@
+Put PDFs, PPTs, and whatever other miscellaneous asset files here. Paths in this folder map to paths
+in the compiled folder. For example, assets/about_us.pdf would be copied to compiled/about_us.pdf.
+Remember that everything you put here will be checked into git. If you're deploying with Capistrano,
+a large repository will slow down your deployment. For this reason, and for better download times
+for your users, it's often better to host your large asset files on a CDN instead.

data/empty_project/compiled/css/screen.css ADDED Viewed

	@@ -0,0 +1 @@
1	+ body {font-family: sans-serif;}

data/empty_project/compiled/index.html ADDED Viewed

@@ -0,0 +1,12 @@
+<!DOCTYPE html>
+<html>
+  <head>
+    <title>Home - Site Name Here</title>
+    <link rel="stylesheet" type="text/css" href="/css/screen.css"/>
+    <script type="text/javascript" src="/js/interaction.js"></script>
+  </head>
+  <body>
+    <h1>Home</h1>
+  </body>
+</html>

data/empty_project/compiled/js/interaction.js ADDED Viewed

	@@ -0,0 +1 @@
1	+ // Nothing here yet. This JS file is referenced from the default layout.

data/empty_project/config.rb ADDED Viewed

@@ -0,0 +1,3 @@
+Ichiban.config do |config|
+  config.relative_url_root = '/'
+end

data/empty_project/data/readme.txt ADDED Viewed

	@@ -0,0 +1,2 @@
1	+ If you have some data sources that you use to auto-generate HTML, such as CSV or XML files,
2	+ you can put them in here.

data/empty_project/helpers/readme.txt ADDED Viewed

@@ -0,0 +1,10 @@
+You can write custom helper modules and put them in this directory. The methods they define
+will be available in your templates. For example:
+# helpers/my_helper.rb
+module MyHelper
+  def double(num)
+    num * 2
+  end
+end

data/empty_project/html/index.html ADDED Viewed

@@ -0,0 +1,3 @@
+<% @page_title = 'Home' %>
+<h1>Home</h1>

data/empty_project/layouts/default.html ADDED Viewed

@@ -0,0 +1,12 @@
+<!DOCTYPE html>
+<html>
+  <head>
+    <title><%= @page_title %> - Site Name Here</title>
+    <%= stylesheet_link_tag 'screen.css' %>
+    <%= javascript_include_tag 'interaction.js' %>
+  </head>
+  <body>
+    <%= yield %>
+  </body>
+</html>

data/empty_project/models/readme.txt ADDED Viewed

@@ -0,0 +1,3 @@
+IF you're doing a lot with datasources, it's good to keep things tidy and put the logic in
+separate model files. That's what this directory is for. Any Ruby files in this directory will be
+automatically loaded.

data/empty_project/scripts/readme.txt ADDED Viewed

@@ -0,0 +1,6 @@
+This folder is for scripts that generate pages.
+If you want some auto-generated code *within a single page*, it's easy: Just use some <% %> tags.
+But suppose you have an XML file describing every employee in your company, and you want an
+*individual* page for each one. That's where this folder coms in. You need to create a script
+that generates each page based on a template. See the documentation for more details.

data/empty_project/webserver/htaccess.txt ADDED Viewed

@@ -0,0 +1,24 @@
+RewriteEngine On
+# Force the trailing slash for all pages unless they end in .html
+RewriteCond %{REQUEST_FILENAME} !-f
+RewriteCond %{REQUEST_FILENAME} !-d
+# Skipping pages with the .html extension is necessary to avoid an infinite chain of .html. See the note at the bottom.
+RewriteCond %{REQUEST_URI} !\.html$
+RewriteRule ^(.*[^/])$ /$1/ [R=301,L]
+RewriteCond %{REQUEST_FILENAME} !-f
+RewriteCond %{REQUEST_FILENAME} !-d
+# If the HTML file doesn't exist don't attempt to rewrite, or we'll get an infinite loop
+RewriteCond %{REQUEST_FILENAME}.html -f
+# If we've already tried appending HTML and the file still doesn't exist, don't do it again. See the note at the bottom.
+RewriteCond %{REQUEST_URI} !\.html$
+RewriteRule ^(.*)/$ $1.html
+ErrorDocument 404 /404.html
+ErrorDocument 422 /422.html
+ErrorDocument 500 /500.html
+# Note on infinite .html appending loops: We have to take pains to ensure that if a certain file, say foo.html, exists,
+# then a path like /foo/bar won't get .html appended an infinite number of times. This can happen because %{REQUEST_FILENAME}
+# would match /foo/bar/ to foo.html. Our redirect to force trailing slashes then sends us through an infinite loop.

data/lib/ichiban/asset_compiler.rb ADDED Viewed

@@ -0,0 +1,21 @@
+module Ichiban
+  class AssetCompiler
+    def initialize(file)
+      @file = file
+    end
+    def compile
+      dir = File.dirname @file.dest
+      unless File.directory? dir
+        FileUtils.mkdir_p dir
+      end
+      case @file
+      when Ichiban::SCSSFile
+        Sass.compile_file @file.abs, @file.dest
+      else
+        FileUtils.cp @file.abs, @file.dest
+      end
+      Ichiban.logger.compilation(@file.abs, @file.dest)
+    end
+  end
+end

data/lib/ichiban/bundle.rb ADDED Viewed

@@ -0,0 +1,7 @@
+module Ichiban
+  def self.load_bundle
+    if Ichiban.project_root and File.exists?(File.join(Ichiban.project_root, 'Gemfile'))
+      Bundler.require
+    end
+  end
+end

data/lib/ichiban/command.rb CHANGED Viewed

@@ -6,15 +6,25 @@ module Ichiban
     end
     def print_usage
-      puts "Usage: ichiban <command>"
-      puts "  Available commands: watch"
+      puts(
+        "Usage: ichiban [command]\n" +
+        "Available commands: \n" +
+        "  watch\n" +
+        "  new [path]"
+      )
     end
     def run
-      Ichiban.project_root = Dir.getwd
       case @task
       when 'watch'
+        Ichiban.project_root = Dir.getwd
+        Ichiban.load_bundle
         Ichiban::Watcher.new.start
+      when 'new'
+        Ichiban::ProjectGenerator.new(
+          File.expand_path(@args[0])
+        ).generate
+        puts "Initialized Ichiban project in #{@args[0]}"
       else
         print_usage
       end

data/lib/ichiban/config.rb CHANGED Viewed

@@ -9,8 +9,8 @@ module Ichiban
     attr_writer :relative_url_root
     def self.load_file
-      config_file = ::File.join(Ichiban.project_root, 'config.rb')
-      raise "#{config_file} must exist" unless ::File.exists?(config_file)
+      config_file = File.join(Ichiban.project_root, 'config.rb')
+      raise "#{config_file} must exist" unless File.exists?(config_file)
       load config_file
     end

data/lib/ichiban/deleter.rb CHANGED Viewed

@@ -2,19 +2,16 @@ module Ichiban
   class Deleter
     # Deletes a file's associated destination file, if any.
     def delete_dest(path)
-      file = Ichiban::File.from_abs(path)
-      # file will be nil if the path doesn't map to a known subclass of Ichiban::File. Furthermore,
-      # even if file is not nil, it may be a kind of Ichiban::File that does not have a destination.
+      file = Ichiban::ProjectFile.from_abs(path)
+      # file will be nil if the path doesn't map to a known subclass of IchibanFile. Furthermore,
+      # even if file is not nil, it may be a kind of IchibanFile that does not have a destination.
       if file and file.has_dest?
         dest = file.dest
       else
         dest = nil
       end
-      if dest and ::File.exists?(dest)
-        puts 'yep'
+      if dest and File.exists?(dest)
         FileUtils.rm(dest)
-      else
-        puts 'nope'
       end
       # Log the deletion(s)

data/lib/ichiban/dependencies.rb CHANGED Viewed

@@ -2,32 +2,53 @@ module Ichiban
   module Dependencies
     @graphs = {}
-    # graph_file_path is an absolute path.
+    # Does not delete the files. Just clears the graphs from memory. This gets called whenever
+    # Ichiban.project_root is changed.
+    def self.clear_graphs
+      @graphs = {}
+    end
+    def self.delete_dep(graph_file_path, dep)
+      ensure_graph_initialized(graph_file_path)
+      graph = @graphs[graph_file_path]
+      graph.each do |ind, deps|
+        deps.delete dep
+      end
+      save_graph_file(graph_file_path, graph)
+    end
+    # graph_file_path is a relative path
     def self.graph(graph_file_path)
       ensure_graph_initialized(graph_file_path)
       @graphs[graph_file_path]
     end
+    # graph_file_path is a relative path
     def self.ensure_graph_initialized(graph_file_path)
       unless @graphs[graph_file_path]
-        if ::File.exists?(graph_file_path)
-          @graphs[graph_file_path] = JSON.parse(::File.read(graph_file_path))
+        abs = File.join(Ichiban.project_root, graph_file_path)
+        if File.exists?(abs)
+          @graphs[graph_file_path] = JSON.parse(File.read(abs))
         else
           @graphs[graph_file_path] = {}
         end
       end
     end
+    def self.save_graph_file(graph_file_path, graph)
+      File.open(File.join(Ichiban.project_root, graph_file_path), 'w') do |f|
+        f << JSON.generate(graph)
+      end
+    end
     # Loads the graph from disk if it's not already in memory. Updates the graph. Writes the new
-    # graph to disk. graph_file_path is an absolute path.
+    # graph to disk. graph_file_path is a relative path.
     def self.update(graph_file_path, ind, dep)
       ensure_graph_initialized(graph_file_path)
       graph = @graphs[graph_file_path]
       graph[ind] ||= []
       graph[ind] << dep unless graph[ind].include?(dep)
-      ::File.open(graph_file_path, 'w') do |f|
-        f << JSON.generate(graph)
-      end
+      save_graph_file(graph_file_path, graph)
     end
   end
 end

data/lib/ichiban/file.rb CHANGED Viewed

@@ -1,10 +1,10 @@
 module Ichiban
-  class File
+  class ProjectFile
     attr_reader :abs
     # Returns an absolute path in the compiled directory
     def dest
-      ::File.join(Ichiban.project_root, 'compiled', dest_rel_to_compiled)
+      File.join(Ichiban.project_root, 'compiled', dest_rel_to_compiled)
     end
     # Returns a new instance based on an absolute path. Will automatically pick the right subclass.
@@ -12,10 +12,14 @@ module Ichiban
     def self.from_abs(abs)
       rel = abs.slice(Ichiban.project_root.length..-1) # Relative to project root
       rel.sub!(/^\//, '') # Remove leading slash
-      if rel.start_with?('html') and rel.end_with?('.html')
-        Ichiban::HTMLFile.new(rel)
+      if rel.start_with?('html') and (rel.end_with?('.html') or rel.end_with?('.md') or rel.end_with?('.markdown'))
+        if File.basename(rel).start_with?('_')
+          Ichiban::PartialHTMLFile.new(rel)
+        else
+          Ichiban::HTMLFile.new(rel)
+        end
       elsif rel.start_with?('layouts') and rel.end_with?('.html')
-        Ichiban::LayoutFIle.new(rel)
+        Ichiban::LayoutFile.new(rel)
       elsif rel.start_with?('assets/js')
         Ichiban::JSFile.new(rel)
       elsif rel.start_with?('assets/css') and rel.end_with?('.css')
@@ -34,6 +38,8 @@ module Ichiban
         Ichiban::ScriptFile.new(rel)
       elsif rel.start_with?('helpers')
         Ichiban::HelperFile.new(rel)
+      elsif rel == 'webserver/htaccess.txt'
+        Ichiban::HtaccessFile.new(rel)
       else
         nil
       end
@@ -45,16 +51,18 @@ module Ichiban
     def initialize(rel)
       @rel = rel
-      @abs = ::File.join(Ichiban.project_root, rel)
+      @abs = File.join(Ichiban.project_root, rel)
     end
+    attr_reader :rel
     # Returns a new path where the old extension is replaced with new_ext
     def replace_ext(path, new_ext)
       path.sub(/\..+$/, '.' + new_ext)
     end
   end
-  class HTMLFile < File
+  class HTMLFile < ProjectFile
     def dest_rel_to_compiled
       d = @rel.slice('html/'.length..-1)
       (d.end_with?('.markdown') or d.end_with?('.md')) ? replace_ext(d, 'html') : d
@@ -63,53 +71,150 @@ module Ichiban
     def update
       Ichiban::HTMLCompiler.new(self).compile
     end
+    def web_path
+      d = dest_rel_to_compiled
+      '/' + File.basename(d, File.extname(d)) + '/'
+    end
+  end
+  class PartialHTMLFile < ProjectFile
+    # Returns something like 'foo/bar'
+    def partial_name
+      File.basename(
+        @abs.slice(Ichiban.project_root.length + 1..-1),
+        File.extname(@abs)
+      )
+    end
+    def update
+      # Normal HTML files that depend on this partial
+      if deps = Ichiban::Dependencies.graph('.partial_dependencies.json')[partial_name]
+        deps.each do |dep|
+          # dep will be a path relative to the html directory. It looks like this: 'folder/file.html'
+          Ichiban::HTMLFile.new(File.join('html', dep)).update
+        end
+      end
+      # Scripts that depend on this partial
+      dep_key = "html/#{partial_name}.html"
+      if deps = Ichiban::Dependencies.graph('.script_dependencies.json')[dep_key]
+        deps.each do |dep|
+          # dep will be a path relative to the html directory. It looks like this: 'folder/file.html'
+          script_path = File.join(Ichiban.project_root, dep)
+          Ichiban.logger.script_run(@abs, script_path)
+          script = Ichiban::Script.new(script_path).run
+        end
+      end
+    end
   end
-  class LayoutFile < File
+  class LayoutFile < ProjectFile
+    def layout_name
+      File.basename(@abs, File.extname(@abs))
+    end
+    def update
+      Ichiban.logger.layout(@abs)
+      if deps = Ichiban::Dependencies.graph('.layout_dependencies.json')[layout_name]
+        deps.each do |dep|
+          # dep is a path relative to the project root
+          if File.exists?(File.join(Ichiban.project_root, dep))
+            Ichiban::HTMLFile.new(dep).update
+          else
+            Dependencies.delete_dep('.layout_dependencies.json', dep)
+          end
+        end
+      end
+    end
   end
-  class JSFile < File
+  class JSFile < ProjectFile
     def dest_rel_to_compiled
       File.join('js', @rel.slice('assets/js/'.length..-1))
     end
+    def update
+      Ichiban::AssetCompiler.new(self).compile
+    end
   end
-  class CSSFile < File
+  class CSSFile < ProjectFile
     def dest_rel_to_compiled
       File.join('css', @rel.slice('assets/css/'.length..-1))
     end
+    def update
+      Ichiban::AssetCompiler.new(self).compile
+    end
   end
-  class SCSSFile < File
+  class SCSSFile < ProjectFile
     def dest_rel_to_compiled
       replace_ext(
         File.join('css', @rel.slice('assets/css/'.length..-1)),
         'css'
       )
     end
+    def update
+      Ichiban::AssetCompiler.new(self).compile
+    end
   end
-  class ImageFile < File
+  class ImageFile < ProjectFile
     def dest_rel_to_compiled
       File.join('img', @rel.slice('assets/img/'.length..-1))
     end
+    def update
+      Ichiban::AssetCompiler.new(self).compile
+    end
   end
-  class MiscAssetFile < File
+  class MiscAssetFile < ProjectFile
     def dest_rel_to_compiled
       @rel.slice('assets/misc/'.length..-1)
     end
+    def update
+      Ichiban::AssetCompiler.new(self).compile
+    end
   end
-  class ModelFile < File
+  class HtaccessFile < ProjectFile
+    def dest_rel_to_compiled
+      '.htaccess'
+    end
+    def update
+      Ichiban::AssetCompiler.new(self).compile
+    end
   end
-  class DataFile < File
+  class ModelFile < ProjectFile
+    def update
+      # No-op. The watcher hands the path to each changed model file to the Loader instance.
+      # So we don't have to worry about that here.
+    end
   end
-  class ScriptFile < File
+  class HelperFile < ProjectFile
+    def update
+      # No-op. The watcher hands the path to each changed model file to the Loader instance.
+      # So we don't have to worry about that here.
+    end
   end
-  class HelperFile < File
+  class DataFile < ProjectFile
+    def update
+      Ichiban.script_runner.data_file_changed(@abs)
+    end
+  end
+  class ScriptFile < ProjectFile
+    def update
+      Ichiban.script_runner.script_file_changed(@abs)
+    end
   end
 end

data/lib/ichiban/helpers.rb CHANGED Viewed

@@ -21,14 +21,14 @@ module Ichiban
       output << tag_attrs(options) << ">#{content}</#{name}>"
     end
-    # Returns the path relative to site root
+    # Returns the path relative to site root. Includes leading and trailing slash.
     def current_path
       @_current_path
     end
     def javascript_include_tag(js_file)
       js_file = js_file + '.js' unless js_file.end_with?('.js')
-      path = normalize_path(::File.join('/javascripts', js_file))
+      path = normalize_path(File.join('/js', js_file))
       content_tag 'script', 'type' => 'text/javascript', 'src' => path
     end
@@ -62,58 +62,16 @@ module Ichiban
       content_tag 'a', text, options.merge('href' => url)
     end
-    # Pass in an array of this form:
-    #
-    #   [
-    #     ['Link Text', '/path/from/relative/url/root/']
-    #     ['Link Text', '/path/from/relative/url/root/', {'id' => 'foo'}]
-    #   ]
-    #
-    # You can also do this, as a convenience:
-    #
-    #   nav([
-    #     ['Link Text', 'path/from/section/root/']
-    #   ], :section => 'section-name')
-    #
-    # Which will generate this href:
-    #
-    #   /section-name/path/from/section/root/
-    #
-    # If you don't specify a section, and your URLs don't have leading slashes,
-    # the hrefs will use relative URLs.
-    def nav(items, options = {})
-      ul_options = _limit_options(options, %w(id class)) { |key, value| key.to_s.start_with?('data-') }
-      content_tag('ul', ul_options) do
-        items.inject('') do |lis, (text, path, attrs)|
-          if options[:section]
-            path = ::File.join(options[:section], path)
-          end
-          path = normalize_path(path)
-          lis + content_tag('li', (attrs or {})) do
-            if path_with_slashes(current_path) == path_with_slashes(path)
-              content_tag('span', text, 'class' => 'selected')
-            else
-              link_to(text, path)
-            end
-          end
-        end
-      end
-    end
-    # If the path has a trailing slash, it will be made absolute using relative_url_root.
+    # If the path has a leading slash, it will be made absolute using relative_url_root.
     # Otherwise, it will remain relative.
     def normalize_path(path)
       if path.start_with?('/')
-        ::File.join(relative_url_root, path)
+        File.join(relative_url_root, path)
       else
         path
       end
     end
-    def page_title(title)
-      @page_title = title
-    end
     # Adds leading and trailing slashes if none are present
     def path_with_slashes(path)
       path = '/' + path unless path.start_with?('/')
@@ -121,13 +79,24 @@ module Ichiban
       path
     end
+    def partial(path)
+      file = Ichiban::PartialHTMLFile.new(
+        File.join('html', path)
+      )
+      # Record the dependency like this: 'folder/partial-name' => 'folder/included-file.html'
+      Ichiban::Dependencies.update('.partial_dependencies.json', file.partial_name, @_template_path)
+      compiler = Ichiban::HTMLCompiler.new(file)
+      compiler.ivars = to_hash # to_hash is inherited from Erubis::Context. It's a hash of the instance variables.
+      compiler.compile_to_str
+    end
     def relative_url_root
       Ichiban.config.relative_url_root
     end
     def stylesheet_link_tag(css_file, media = 'screen')
       css_file = css_file + '.css' unless css_file.end_with?('.css')
-      href = normalize_path(::File.join('/stylesheets', css_file))
+      href = normalize_path(File.join('/css', css_file))
       tag 'link', 'href' => href, 'type' => 'text/css', 'rel' => 'stylesheet', 'media' => media
     end