smallcage 0.1.4 → 0.1.5

data/History.txt

@@ -1,3 +1,13 @@
+== 0.1.5 2009-08-15
+
+* use @erbout for ERB output buffer variable name.
+* add ERB capture method to base_helper.rb.
+* add get directory config method to base_helper.rb.
+* add NKF helper to nkf project template.
+* avoid error when filter config is empty.
+* add statistics line to update command. 
+* do not abort auto update server when ERB error occurred.
+
 == 0.1.4 2009-07-27
 
 * add cache control filter and rake task (for CDN, etag, etc.). 

data/README.rdoc

@@ -0,0 +1,74 @@
+= SmallCage -- Lightweigt CMS Package.
+
+
+== Installation
+
+  $ sudo gem install smallcage
+
+
+== Usage
+
+If successfully installed, smc command will be available.
+
+  $ smc
+  Usage: smc <subcommand> [options]
+  SmallCage 0.1.5 - Lightweight CMS Package.
+  Subcommands are:
+      update [path]                    Build smc contents.
+      clean  [path]                    Remove files generated from *.smc source.
+      server [path] [port]             Start HTTP server.
+      auto   [path] [port]             Start auto update daemon.
+      import [name|uri]                Import project.
+      export [path] [outputpath]       Export project.
+      manifest [path]                  Generate Manifest.html file.
+
+  Options are:
+  
+      -h, --help                       Show this help message.
+      -v, --version                    Show version info.
+
+Create document root.
+  
+  $ mkdir htdocs
+  $ cd htdocs
+
+Import default project.
+
+  $ smc import
+  Import: base
+  Create:
+    /_smc
+    /_smc/helpers
+    /_smc/helpers/base_helper.rb
+    /_smc/helpers/site_helper.rb
+    /_smc/templates
+    /_smc/templates/default.rhtml
+    /_smc/templates/footer.rhtml
+    /_smc/templates/header.rhtml
+
+  Import these files?[Yn]: y
+  A /_smc
+  A /_smc/helpers
+  A /_smc/helpers/base_helper.rb
+  A /_smc/helpers/site_helper.rb
+  A /_smc/templates
+  A /_smc/templates/default.rhtml
+  A /_smc/templates/footer.rhtml
+  A /_smc/templates/header.rhtml
+  :
+
+Publish all smc files.
+
+  $ smc update
+  A /index.html
+  A /sample/index.html
+  A /sample/redirect.html
+  A /sample/sub/contents.html
+  A /sample/sub/index.html
+
+Start HTTP server.
+
+  $ smc server . 8080
+
+...and access http://localhost:8080
+

data/Rakefile

@@ -29,11 +29,11 @@ RDOC_OPTS = [
   "--charset", "utf-8",
   "--opname", "index.html",
   "--line-numbers",
-  "--main", "README.txt",
+  "--main", "README.rdoc",
   "--inline-source",
 ]
 
-SRC_FILES = FileList.new(%w{Rakefile README.txt History.txt License.txt})
+SRC_FILES = FileList.new(%w{Rakefile README.rdoc History.txt License.txt})
 SRC_FILES.include("{bin,doc,lib,test,project,spec}/**/*")
 SRC_FILES.exclude(/~$/)
 
@@ -42,7 +42,7 @@ spec = Gem::Specification.new do |s|
   s.version           = VERS
   s.platform          = Gem::Platform::RUBY
   s.has_rdoc          = true
-  s.extra_rdoc_files  = ["README.txt", "History.txt"]
+  s.extra_rdoc_files  = ["README.rdoc", "History.txt"]
   s.rdoc_options     += RDOC_OPTS + ['--exclude', '^(examples|extras)/']
   s.summary           = DESCRIPTION
   s.description       = DESCRIPTION
@@ -82,14 +82,14 @@ end
 
 
 Rake::RDocTask.new do |rdoc|
-  rdoc.rdoc_dir = 'html'
+  rdoc.rdoc_dir = 'pkg/htdocs'
   rdoc.options += RDOC_OPTS
-  rdoc.template = "resh"
+  #rdoc.template = "resh"
   #rdoc.template = "#{ENV['template']}.rb" if ENV['template']
   if ENV['DOC_FILES']
     rdoc.rdoc_files.include(ENV['DOC_FILES'].split(/,\s*/))
   else
-    rdoc.rdoc_files.include('README.txt', 'History.txt')
+    rdoc.rdoc_files.include('README.rdoc', 'History.txt')
     rdoc.rdoc_files.include('lib/**/*.rb')
     rdoc.rdoc_files.include('ext/**/*.c')
   end

data/lib/smallcage/application.rb

@@ -43,7 +43,7 @@ Subcommands are:
     update [path]                    Build smc contents.
     clean  [path]                    Remove files generated from *.smc source.
     server [path] [port]             Start HTTP server.
-    auto   [path] [port]             Start auto update daemon.
+    auto   [path] [port]             Start auto update server.
     import [name|uri]                Import project.
     export [path] [outputpath]       Export project.
     manifest [path]                  Generate Manifest.html file.

data/lib/smallcage/commands/auto.rb

@@ -68,7 +68,13 @@ module SmallCage::Commands
       target_files = modified_files 
 
       runner = SmallCage::Runner.new({ :path => @target })
-      runner.update
+      begin
+        runner.update
+      rescue Exception => e
+        STDERR.puts e.to_s
+        STDERR.puts $@[0..4].join("\n")
+        STDERR.puts ":"
+      end
       
       update_http_server(target_files)
       puts_line
@@ -101,6 +107,12 @@ module SmallCage::Commands
         update_http_server(target_files)
       end
       puts_line
+    rescue Exception => e
+      STDERR.puts e.to_s
+      STDERR.puts $@[0..4].join("\n")
+      STDERR.puts ":"
+      print "\a" unless quiet? # Bell
+      puts_line
     end
     private :update_modified_files
     

data/lib/smallcage/commands/update.rb

@@ -9,6 +9,7 @@ module SmallCage::Commands
     end
     
     def execute
+      start = Time.now
       target = Pathname.new(@opts[:path])
       unless target.exist?
         raise "target directory or file does not exist.: " + target.to_s
@@ -18,10 +19,14 @@ module SmallCage::Commands
       @renderer = SmallCage::Renderer.new(@loader)
 
       urilist = render_smc_files
+      rendered = urilist.length
       if list_file.exist?
         urilist = delete_expired_files(urilist)
       end
       save_list(urilist)
+      elapsed = Time.now - start
+      
+      puts "-- #{rendered} files.  #{"%.3f" % elapsed} sec.  #{"%.3f" % (elapsed/rendered)} sec/file."
     end
 
     def render_smc_files

data/lib/smallcage/loader.rb

@@ -245,13 +245,12 @@ module SmallCage
       result = {}
       return {} unless @filters_dir.directory?
       
-      filters = load_anonymous(@filters_dir, %r{([^/]+_filter)\.rb$})
+      filter_modules = load_anonymous(@filters_dir, %r{([^/]+_filter)\.rb$})
+      smc_module = filter_modules[:module].const_get("SmallCage")
       
-      config = load_filters_config
-      config.each do |filter_type,filter_list|
+      load_filters_config.each do |filter_type,filter_list|
         result[filter_type] = []
-        smc_module = filters[:module].const_get("SmallCage")
-        filter_list.each do |fc|
+        filter_list.to_a.each do |fc|
           fc = { "name" => fc } if fc.is_a? String
           filter_class = smc_module.const_get(fc["name"].camelize)
           result[filter_type] << filter_class.new(fc)
@@ -264,7 +263,7 @@ module SmallCage
     def load_filters_config
       path = @filters_dir.join("filters.yml")
       return {} unless path.file?
-      return YAML.load(path.read())
+      return YAML.load(path.read()) || {}
     end
     private :load_filters_config
     

data/lib/smallcage/renderer.rb

@@ -11,14 +11,11 @@ class SmallCage::Renderer
   end
     
   def render_string(str, obj)
-    begin
-      erb_class = ERB.new(str, nil, '-').def_class(@loader.erb_base, "erb")
-      result = erb_class.new(@loader, self, obj).erb
-    rescue => e
-      STDERR.puts "Can't render: #{obj["uri"]}"
-      raise e
-    end
-    return result
+    erb_class = ERB.new(str, nil, '-', '@erbout').def_class(@loader.erb_base, "erb")
+    return erb_class.new(@loader, self, obj).erb
+  rescue => e
+    STDERR.puts "Can't render: #{obj["uri"]}"
+    raise e
   end
 
 end

data/lib/smallcage/version.rb

@@ -2,7 +2,7 @@ module SmallCage #:nodoc:
   module VERSION #:nodoc:
     MAJOR = 0
     MINOR = 1
-    TINY  = 4
+    TINY  = 5
 
     STRING = [MAJOR, MINOR, TINY].join('.')
   end

data/project/base/_smc/helpers/base_helper.rb

@@ -2,6 +2,7 @@ module SmallCage
   module BaseHelper
     include ERB::Util
 
+    # Glob files with regular expression.
     def _glob(path, rex)
       base_dir = nil
       if path.to_s[0] == ?/
@@ -15,26 +16,76 @@ module SmallCage
       entries = Dir.glob("#{base_dir}/**/*")
       
       result = []
-      entries.each do |path|
-        result << path if path.to_s =~ rex
+      entries.each do |entry|
+        result << entry if entry.to_s =~ rex
       end
       return result.sort
     end
 
-    def _with(o)
-      tmpobj = @obj
-      @obj = o
+    # Switch current smc object and execute block.
+    #
+    #   <%- docroot = dirs.first["path"]
+    #       _with(_load(docroot + "/company_001.html.smc")) do -%>
+    #         name: <%= name %><br />
+    #         address: <%= address %>
+    #   <%- end -%>
+    # 
+    def _with(new_obj)
+      @obj, old_obj = new_obj, @obj
       yield
-      @obj = tmpobj
+    ensure
+      @obj = old_obj
     end
     
+    # Load smc file.
+    #
+    #   docroot = dirs.first["path"]
+    #   item = _load(docroot + "/items/001.html.smc")
+    #
     def _load(path)
       path = Pathname.new(path)
       @loader.load(path)
     end
     
-    def _erb(body)
-      @renderer.render_string(body, @obj)
+    # Evaluate ERB source.
+    def _erb(source)
+      @renderer.render_string(source, @obj)
+    end
+    
+    # Capture ERB output.
+    #
+    #   def cdata(&block)
+    #     src = _capture(&block)
+    #     @erbout << "<![CDATA[" + src.gsub(/\]\]>/,"]]]]><![CDATA[>") + "]]>"  
+    #   end
+    #
+    #   <%- cdata do -%>
+    #      <<< Here is CDATA section. >>>
+    #   <%- end -%>
+    #
+    def _capture(*args, &block)
+      @erbout, old_erbout = "", @erbout
+      block.call(*args)
+      return @erbout
+    ensure
+      @erbout = old_erbout
+    end
+    
+    # Get value of
+    #  - smc object
+    #  - or directory config (_dir.smc)
+    #  - or nil
+    def _get(name, obj = @obj)
+      return obj[name] if obj[name]
+      return _dir(name, obj)
+    end
+
+    # Return nearest parent directory config(_dir.smc) value. 
+    def _dir(name, obj = @obj)
+      obj["dirs"].reverse.each do |dir|
+        return dir[name] if dir[name]
+      end
+      return nil
     end
     
   end

data/project/nkf/_smc/filters/filters.yml

@@ -1,3 +1,2 @@
 after_rendering_filters:
   - name: nkf_filter
-    args: "-W -s" # UTF-8 to SJIS

data/project/nkf/_smc/filters/nkf_filter.rb

@@ -1,14 +1,42 @@
+require "nkf"
+
 module SmallCage
-  require "nkf"
-  
+
+  # In _dir.smc or other *.smc, set charset like this:
+  # 
+  #   charset: Shift_JIS
+  #   
   class NkfFilter
 
     def initialize(opts)
-      @args = opts["args"]
     end
 
     def after_rendering_filter(obj, str)
-      return NKF.nkf(@args, str)
+      charset = ""
+      if obj["charset"]
+        charset = obj["charset"]
+      else
+        obj["dirs"].reverse.each do |dir|
+          if dir["charset"]
+            charset = dir["charset"]
+            break
+          end
+        end
+      end
+
+      opt = ""
+      if charset =~ /^euc-jp$/i
+        opt = "-Wem0"
+      elsif charset =~ /^iso-2022-jp$/i
+        opt = "-Wjm0"
+      elsif charset =~ /^shift_jis$/i
+        opt = "-Wsm0"
+      else
+        STDERR.puts "Unknown charset: #{charset}" unless charset.empty? 
+        return str
+      end      
+      
+      return NKF.nkf(opt, str)
     end
 
   end

data/project/nkf/_smc/helpers/nkf_helper.rb

@@ -0,0 +1,60 @@
+require "nkf"
+
+module SmallCage
+  module NkfHelper
+
+    def shift_jis(&block)
+      nkf("-Wsm0", &block)
+    end
+    
+    def iso_2022_jp(&block)
+      nkf("-Wjm0", &block)
+    end
+    
+    def euc_jp(&block)
+      nkf("-Wem0", &block)
+    end
+    
+    def nkf(opt, &block)
+      src = _capture(&block)
+      @erbout << NKF.nkf(opt, src)
+    end
+
+    def charset
+      return _get("charset") || "UTF-8"
+    end
+
+    # Convert charset inside of block.
+    # 
+    #   <%- set_charset do -%>
+    #      <%= header %>
+    #      <%= body %>
+    #      <%= footer %>
+    #   <%- end -%>
+    #   
+    # In _dir.smc or other *.smc:
+    # 
+    #   charset: Shift_JIS
+    #
+    # In header.rhtml:
+    #
+    #   <meta http-equiv="Content-Type" content="text/html; charset=<%= charset %>">
+    #
+    # If you have to edit all templates to call set_charset method,
+    # you should use nkf_filter.rb instead.
+    # 
+    def set_charset(&block)
+      c = charset()
+      if c =~ /^euc-jp$/i
+        euc_jp(&block)
+      elsif c =~ /^iso-2022-jp$/i
+        iso_2022_jp(&block)
+      elsif c =~ /^shift_jis$/i
+        shift_jis(&block)
+      else
+        yield
+      end
+    end
+    
+  end
+end

data/spec/data/htdocs1/_smc/filters/filters.yml

@@ -0,0 +1 @@
+after_rendering_filters:

data/spec/manifest_spec.rb

@@ -20,6 +20,8 @@ describe "SmallCage::Commands::Manifest" do
     contents = <<'EOT'.split(/\n/)
 <li><a href="./_dir.smc">./_dir.smc</a></li>
 <li><a href="./_smc/">./_smc/</a></li>
+<li><a href="./_smc/filters/">./_smc/filters/</a></li>
+<li><a href="./_smc/filters/filters.yml">./_smc/filters/filters.yml</a></li>
 <li><a href="./a/">./a/</a></li>
 <li><a href="./a/b/">./a/b/</a></li>
 <li><a href="./a/b/c/">./a/b/c/</a></li>

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: smallcage
 version: !ruby/object:Gem::Version 
-  version: 0.1.4
+  version: 0.1.5
 platform: ruby
 authors: 
 - SAITO Toshihiro
@@ -11,7 +11,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-07-27 00:00:00 +09:00
+date: 2009-08-15 00:00:00 +09:00
 default_executable: 
 dependencies: []
 
@@ -22,11 +22,11 @@ executables:
 extensions: []
 
 extra_rdoc_files: 
-- README.txt
+- README.rdoc
 - History.txt
 files: 
 - Rakefile
-- README.txt
+- README.rdoc
 - History.txt
 - License.txt
 - bin/smc
@@ -65,6 +65,7 @@ files:
 - project/news/_smc/helpers/news_helper.rb
 - project/nkf/_smc/filters/filters.yml
 - project/nkf/_smc/filters/nkf_filter.rb
+- project/nkf/_smc/helpers/nkf_helper.rb
 - project/rake/_smc/Rakefile
 - project/rake/_smc/rakelib/csv.rake
 - project/rake/_smc/rakelib/svn.rake
@@ -107,7 +108,9 @@ files:
 - project/tutorial2/tutorial2/priorities.txt.smc
 - project/tutorial2/tutorial2/vars.txt.smc
 - spec/data/htdocs1/_dir.smc
+- spec/data/htdocs1/_smc/filters/filters.yml
 - spec/data/htdocs1/a/b/c/index.html.smc
+- spec/data/htdocs2/_smc/filters/filters.yml
 - spec/data/htdocs2/_smc/templates/dummy.rhtml
 - spec/data/htdocs2/a/b/c/test.html
 - spec/data/htdocs2/a/b/test.html
@@ -135,7 +138,7 @@ rdoc_options:
 - index.html
 - --line-numbers
 - --main
-- README.txt
+- README.rdoc
 - --inline-source
 - --exclude
 - ^(examples|extras)/

data/README.txt

@@ -1,61 +0,0 @@
-
-SmallCage - Lightweigt CMS Package.
-
-
-INSTALL
-
-$ sudo gem install smallcage
-
-
-USAGE
-
-$ smc help
-
-Usage: smc <subcommand> [options]
-SmallCage 0.1.3 - Lightweight CMS Package.
-Subcommands are:
-    update [path]                    Build smc contents.
-    clean  [path]                    Remove files generated from *.smc source.
-    server [path] [port]             Start HTTP server.
-    auto   [path] [port]             Start auto update daemon.
-    import [name|uri]                Import project.
-    export [path] [outputpath]       Export project.
-    manifest [path]                  Generate Manifest.html file.
-
-Options are:
-
-    -h, --help                       Show this help message.
-    -v, --version                    Show version info.
-
-$ mkdir htdocs
-$ cd htdocs
-$ smc import
-Import: base
-Create:
-  /_smc
-  /_smc/helpers
-  /_smc/helpers/base_helper.rb
-  /_smc/helpers/site_helper.rb
-  /_smc/templates
-  /_smc/templates/default.rhtml
-  /_smc/templates/footer.rhtml
-  /_smc/templates/header.rhtml
-
-Import these files?[yN]: y
-A /_smc
-A /_smc/helpers
-A /_smc/helpers/base_helper.rb
-:
-
-$ smc update
-A /index.html
-A /sample/index.html
-A /sample/redirect.html
-A /sample/sub/contents.html
-A /sample/sub/index.html
-
-$ smc server . 8080
-:
-...and access
-http://localhost:8080/
-