ichiban 1.0.10 → 1.0.12

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 493fedcf1994573c9e8dc03c7bd288893d3c8b39
+  data.tar.gz: 33a5e9a79f14ec03267c866780cc67033cd2c9ae
+SHA512:
+  metadata.gz: 9cf876c1ba23d929bc2fca3e30d459e562cd68c1114a1bd14f666b4fcea6955e04a15e6931e5a7f514a0a921719c154c00a19e855b8cfe652083b745a9f82855
+  data.tar.gz: dd97fdd59a181f94090640ab9e013c498ea42ea1d80fd220df5fdcd1ae44e584d28adfda61a964fff6f9e9f3ba58707424a865468e25e86ec3e2f1ca0193778d

data/empty_project/compiled/.htaccess

@@ -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/ejs_compiler.rb

@@ -0,0 +1,31 @@
+module Ichiban
+  class EJSCompiler
+    def compile
+      FileUtils.mkdir_p File.dirname(@ejs_file.dest)
+      File.open(@ejs_file.dest, 'w') do |f|
+        f << compile_to_str
+      end
+      Ichiban.logger.compilation(@ejs_file.abs, @ejs_file.dest)
+    end
+  
+    def compile_to_str
+      add_preamble(
+        EJS.compile(
+          File.read(@ejs_file.abs)
+        ),
+        File.basename(@ejs_file.dest, '.js')
+      )
+    end
+  
+    def initialize(ejs_file)
+      @ejs_file = ejs_file
+    end
+    
+    private
+    
+    def add_preamble(fn, name)
+      %Q(if (typeof(window.EJS) == "undefined") { window.EJS = {} } ) +
+      %Q(window.EJS[#{JSON.dump(name)}] = #{fn})
+    end
+  end
+end

data/lib/ichiban/file.rb

@@ -1,5 +1,7 @@
 module Ichiban
   class ProjectFile
+    @types = []
+    
     attr_reader :abs
     
     # Returns an absolute path in the compiled directory
@@ -12,34 +14,12 @@ 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') 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)
-      elsif rel.start_with?('assets/js')
-        Ichiban::JSFile.new(rel)
-      elsif rel.start_with?('assets/css') and rel.end_with?('.css')
-        Ichiban::CSSFile.new(rel)
-      elsif rel.start_with?('assets/css') and rel.end_with?('.scss')
-        Ichiban::SCSSFile.new(rel)
-      elsif rel.start_with?('assets/img')
-        Ichiban::ImageFile.new(rel)
-      elsif rel.start_with?('assets/misc')
-        Ichiban::MiscAssetFile.new(rel)
-      elsif rel.start_with?('models')
-        Ichiban::ModelFile.new(rel)
-      elsif rel.start_with?('data')
-        Ichiban::DataFile.new(rel)
-      elsif rel.start_with?('scripts')
-        Ichiban::ScriptFile.new(rel)
-      elsif rel.start_with?('helpers')
-        Ichiban::HelperFile.new(rel)
-      elsif rel == 'webserver/htaccess.txt'
-        Ichiban::HtaccessFile.new(rel)
+      handler = @types.detect do |_, proc|
+        proc.call rel
+      end
+      if handler
+        klass = handler.first
+        klass.new rel
       else
         nil
       end
@@ -54,6 +34,15 @@ module Ichiban
       @abs = File.join(Ichiban.project_root, rel)
     end
     
+    # Pass in a subclass of Ichiban::ProjectFile and a block. The block accepts one param:
+    # a file path relative to the Ichiban project root. For example: 'assets/css/main.css'.
+    # Each time the watcher detects a change to a file, the file's path will be passed to
+    # the block. If the block returns true, an instance of klass will be created to compile
+    # the changed file.
+    def self.register_type(klass, &block)
+      @types << [klass, block]
+    end
+    
     attr_reader :rel
     
     # Returns a new path where the old extension is replaced with new_ext
@@ -74,7 +63,13 @@ module Ichiban
     
     def web_path
       d = dest_rel_to_compiled
-      '/' + File.basename(d, File.extname(d)) + '/'
+      fname = File.basename(d, File.extname(d))
+      if fname == 'index'
+        # If this is an index file, the web path is just the folder name.
+        '/' + File.dirname(d) + '/'
+      else
+        '/' + File.join(File.dirname(d), fname) + '/'
+      end
     end
   end
   
@@ -142,6 +137,16 @@ module Ichiban
     end
   end
   
+  class EJSFile < ProjectFile
+    def dest_rel_to_compiled
+      File.join('ejs', File.basename(@rel, '.ejs') + '.js')
+    end
+    
+    def update
+      Ichiban::EJSCompiler.new(self).compile
+    end
+  end
+  
   class CSSFile < ProjectFile
     def dest_rel_to_compiled
       File.join('css', @rel.slice('assets/css/'.length..-1))
@@ -197,14 +202,14 @@ module Ichiban
   
   class ModelFile < ProjectFile
     def update
-      # No-op. The watcher hands the path to each changed model file to the Loader instance.
+      # No-op. The watcher hands the path to every changed file to the Loader instance.
       # So we don't have to worry about that here.
     end
   end
   
   class HelperFile < ProjectFile
     def update
-      # No-op. The watcher hands the path to each changed model file to the Loader instance.
+      # No-op. The watcher hands the path to every changed file to the Loader instance.
       # So we don't have to worry about that here.
     end
   end
@@ -220,4 +225,30 @@ module Ichiban
       Ichiban.script_runner.script_file_changed(@abs)
     end
   end
+  
+  # Re-open this class to register all default file types
+  class ProjectFile
+    register_type(Ichiban::PartialHTMLFile) do |rel|
+      rel.start_with?('html') and
+      (rel.end_with?('.html') or rel.end_with?('.md') or rel.end_with?('.markdown')) and
+      File.basename(rel).start_with?('_')
+    end
+    register_type(Ichiban::HTMLFile) do |rel|
+      rel.start_with?('html') and
+      (rel.end_with?('.html') or rel.end_with?('.md') or rel.end_with?('.markdown')) and
+      !File.basename(rel).start_with?('_')
+    end
+    register_type(Ichiban::LayoutFile)    { |rel| rel.start_with?('layouts') and rel.end_with?('.html') }
+    register_type(Ichiban::JSFile)        { |rel| rel.start_with?('assets/js') }
+    register_type(Ichiban::EJSFile)       { |rel| rel.start_with?('assets/ejs') and rel.end_with?('.ejs') }
+    register_type(Ichiban::CSSFile)       { |rel| rel.start_with?('assets/css') and rel.end_with?('.css') }
+    register_type(Ichiban::SCSSFile)      { |rel| rel.start_with?('assets/css') and rel.end_with?('.scss') }
+    register_type(Ichiban::ImageFile)     { |rel| rel.start_with?('assets/img') }
+    register_type(Ichiban::MiscAssetFile) { |rel| rel.start_with?('assets/misc') }
+    register_type(Ichiban::ModelFile)     { |rel| rel.start_with?('models') }
+    register_type(Ichiban::DataFile)      { |rel| rel.start_with?('data') }
+    register_type(Ichiban::ScriptFile)    { |rel| rel.start_with?('scripts') }
+    register_type(Ichiban::HelperFile)    { |rel| rel.start_with?('helpers') }
+    register_type(Ichiban::HtaccessFile)  { |rel| rel == 'webserver/htaccess.txt' }
+  end
 end

data/lib/ichiban/html_compiler.rb

@@ -1,6 +1,7 @@
 module Ichiban
   class HTMLCompiler
     def compile
+      FileUtils.mkdir_p File.dirname(@html_file.dest)
       File.open(@html_file.dest, 'w') do |f|
         f << compile_to_str
       end

data/lib/ichiban/scripts.rb

@@ -64,8 +64,10 @@ module Ichiban
         )
       )
       compiler.ivars = {:_current_path => web_path}.merge(ivars)
-      html = compiler.compile_to_str
-      File.open(File.join(Ichiban.project_root, 'compiled', dest_path), 'w') do |f|
+      html = compiler.compile_to_str      
+      abs_dest_path = File.join(Ichiban.project_root, 'compiled', dest_path)
+      FileUtils.mkdir_p File.dirname(abs_dest_path)
+      File.open(abs_dest_path, 'w') do |f|
         f << html
       end
       Ichiban.logger.compilation(

data/lib/ichiban/watcher.rb

@@ -11,11 +11,34 @@ module Ichiban
       
       Ichiban.logger.out 'Starting watcher'
       begin
-        if blocking
-          boot_listen_gem
-        else
-          Thread.new { boot_listen_gem }
+        @listener = Listen.to(
+          File.join(Ichiban.project_root, 'html'),
+          File.join(Ichiban.project_root, 'layouts'),
+          File.join(Ichiban.project_root, 'assets'),
+          File.join(Ichiban.project_root, 'models'),
+          File.join(Ichiban.project_root, 'helpers'),
+          File.join(Ichiban.project_root, 'scripts'),
+          File.join(Ichiban.project_root, 'data'),
+          File.join(Ichiban.project_root, 'webserver')
+        )
+        .ignore(/.listen_test$/)
+        .latency(@options[:latency])
+        .change do |modified, added, deleted|
+          (modified + added).uniq.each do |path|
+            if file = Ichiban::ProjectFile.from_abs(path)
+              @loader.change(file) # Tell the Loader that this file has changed
+              begin
+                file.update
+              rescue => exc
+                Ichiban.logger.exception(exc)
+              end
+            end
+          end                    
+          deleted.each do |path|
+            Ichiban::Deleter.new.delete_dest(path)
+          end
         end
+        @listener.start(blocking)
       rescue Interrupt
         Ichiban.logger.out "Stopping watcher"
         exit 0
@@ -29,38 +52,5 @@ module Ichiban
         @listener = nil
       end
     end
-    
-    private
-    
-    def boot_listen_gem
-      @listener = Listen.to(
-        File.join(Ichiban.project_root, 'html'),
-        File.join(Ichiban.project_root, 'layouts'),
-        File.join(Ichiban.project_root, 'assets'),
-        File.join(Ichiban.project_root, 'models'),
-        File.join(Ichiban.project_root, 'helpers'),
-        File.join(Ichiban.project_root, 'scripts'),
-        File.join(Ichiban.project_root, 'data'),
-        File.join(Ichiban.project_root, 'webserver'),
-        ignore: /.listen_test$/,
-        latency: @options[:latency],
-      ) do |modified, added, deleted|
-        (modified + added).uniq.each do |path|
-          if file = Ichiban::ProjectFile.from_abs(path)
-            @loader.change(file) # Tell the Loader that this file has changed
-            begin
-              file.update
-            rescue => exc
-              Ichiban.logger.exception(exc)
-            end
-          end
-        end
-        deleted.each do |path|
-          Ichiban::Deleter.new.delete_dest(path)
-        end
-      end
-      @listener.start
-      sleep
-    end
   end
 end

data/lib/ichiban.rb

@@ -9,10 +9,12 @@ require 'erb' # Just for the helpers
 require 'active_support/core_ext/array/extract_options'
 require 'active_support/inflector'
 require 'sass'
-require 'listen'
 require 'erubis'
 require 'rake'
 require 'bundler'
+gem 'listen', '= 0.7.3'
+require 'listen'
+require 'ejs'
 
 # Ichiban files. Order matters!
 require 'ichiban/bundle'
@@ -29,6 +31,7 @@ require 'ichiban/helpers'
 require 'ichiban/nav_helper'
 require 'ichiban/html_compiler'
 require 'ichiban/asset_compiler'
+require 'ichiban/ejs_compiler'
 require 'ichiban/markdown'
 require 'ichiban/scripts'
 

metadata

@@ -1,8 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: ichiban
 version: !ruby/object:Gem::Version
-  version: 1.0.10
-  prerelease: 
+  version: 1.0.12
 platform: ruby
 authors:
 - Jarrett Colby
@@ -11,132 +10,130 @@ bindir: bin
 cert_chain: []
 date: 2012-11-29 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: ejs
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: erubis
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: sass
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: listen
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '='
       - !ruby/object:Gem::Version
-        version: 2.7.1
+        version: 0.7.3
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '='
       - !ruby/object:Gem::Version
-        version: 2.7.1
+        version: 0.7.3
 - !ruby/object:Gem::Dependency
   name: activesupport
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: mocha
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: turn
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: lorax
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
 description: Static website compiler with advanced feature, including watcher script.
@@ -146,12 +143,31 @@ executables:
 extensions: []
 extra_rdoc_files: []
 files:
+- bin/ichiban
+- empty_project/assets/css/screen.scss
+- empty_project/assets/js/interaction.js
+- empty_project/assets/misc/readme.txt
+- empty_project/compiled/.htaccess
+- empty_project/compiled/css/screen.css
+- empty_project/compiled/index.html
+- empty_project/compiled/js/interaction.js
+- empty_project/config.rb
+- empty_project/data/readme.txt
+- empty_project/deploy.sh
+- empty_project/helpers/readme.txt
+- empty_project/html/index.html
+- empty_project/layouts/default.html
+- empty_project/models/readme.txt
+- empty_project/scripts/readme.txt
+- empty_project/webserver/htaccess.txt
+- lib/ichiban.rb
 - lib/ichiban/asset_compiler.rb
 - lib/ichiban/bundle.rb
 - lib/ichiban/command.rb
 - lib/ichiban/config.rb
 - lib/ichiban/deleter.rb
 - lib/ichiban/dependencies.rb
+- lib/ichiban/ejs_compiler.rb
 - lib/ichiban/file.rb
 - lib/ichiban/helpers.rb
 - lib/ichiban/html_compiler.rb
@@ -162,74 +178,44 @@ files:
 - lib/ichiban/project_generator.rb
 - lib/ichiban/scripts.rb
 - lib/ichiban/watcher.rb
-- lib/ichiban.rb
-- empty_project/assets/css/screen.scss
-- empty_project/assets/js/interaction.js
-- empty_project/assets/misc/readme.txt
-- empty_project/compiled/css/screen.css
-- empty_project/compiled/index.html
-- empty_project/compiled/js/interaction.js
-- empty_project/config.rb
-- empty_project/data/readme.txt
-- empty_project/deploy.sh
-- empty_project/helpers/readme.txt
-- empty_project/html/index.html
-- empty_project/layouts/default.html
-- empty_project/models/readme.txt
-- empty_project/scripts/readme.txt
-- empty_project/webserver/htaccess.txt
-- bin/ichiban
 homepage: https://github.com/jarrett/ichiban
 licenses: []
-post_install_message: ! '
+metadata: {}
+post_install_message: |2-
 
   Ichiban was installed successfully.
-
   Type `ichiban` for usage hints.
 
-
   If you intend to use Markdown in your projects,
-
   be sure to install one of these Markdown gems:
-
   redcarpet
-
   maruku
-
   rdiscount
 
-
   Ichiban uses Guard (http://github.com/guard/guard).
-
   When you run `ichiban watch`, Guard may prompt
-
   you to install an event listener specific to your
-
   operating system. Follow its advice.
 
-
   For more information:
-
-  https://github.com/jarrett/ichiban'
+  https://github.com/jarrett/ichiban
 rdoc_options: []
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.25
+rubygems_version: 2.2.2
 signing_key: 
-specification_version: 3
+specification_version: 4
 summary: Ichiban
 test_files: []