smallcage 0.2.6 → 0.2.7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 6aceb5682ca0ccf02101888c9b0352d1e90cf345
-  data.tar.gz: df68dc9ff5ef3d48f77afb617308565f32c673a7
+  metadata.gz: 24a1fa9291e27aa8accda9f6a2f59110ed2e85e6
+  data.tar.gz: eef2ad497718133501587a57a06b6444a047988f
 SHA512:
-  metadata.gz: a6e0f5020364e558e6e6be8ec961ea2a54ab578b084e6890b50356d935d22484ece6e76a29843f5c8b57a2824e284954243046107aea834b05098ef0a0466e22
-  data.tar.gz: 6a1390f2865a837a1628aadd265e3046eae2b7f3baf7c1e0e6f2a1db276a549fc2b76f04723a5c421b84f19972e1edd48b5f9d8e392246fb4e0082e3725c9783
+  metadata.gz: 30db05e645ca960f444d8a9f23fc1e724199e053cc29ccfe1e69cb03117f4e08d1d6f02daff9bbd60cd44a77fc513e9f46b6ca2c1691c9598d899957781b8760
+  data.tar.gz: 1c9dbed249dc5512594639aa1600721c72760186b47b3819feb5fa5b628f943090871fa261c2f9962b7818cbd9f64de95a0877ed53d2f4e75a38308b6acf7172

data/.rubocop.yml

@@ -1,3 +1,6 @@
+LineLength:
+  Max: 119
+
 ClassLength:
   Max: 300
 

data/Gemfile

@@ -3,7 +3,7 @@ source "https://rubygems.org"
 gem 'syck', :platforms => :ruby_20
 
 group :development, :test do
-  gem 'rspec'
+  gem 'rspec', '~> 3.3.0'
 end
 
 group :development do
@@ -11,9 +11,10 @@ group :development do
 
   platforms :ruby_19, :ruby_20 do
     gem 'simplecov', :require => false
-    gem 'rubocop', :require => false
+    gem 'awesome_print'
 
     if RUBY_VERSION >= '1.9.3'
+      gem 'rubocop', '~> 0.33.0', :require => false
       gem 'guard', :require => false
       gem 'guard-rspec', :require => false
     end

data/lib/smallcage/application.rb

@@ -1,18 +1,18 @@
+# Parse command-line arguments and run application.
 class SmallCage::Application
-  require 'optparse'
-  VERSION_NOTE = "SmallCage #{SmallCage::VERSION} - a simple website generator"
+  require 'English'
 
-  @@signal_handlers = nil
+  @signal_handlers = nil
 
   def self.init_signal_handlers
-    @@signal_handlers = {
-      "INT" => [],
-      "TERM" => []
+    @signal_handlers = {
+      'INT' => [],
+      'TERM' => []
     }
 
-    @@signal_handlers.keys.each do |signal|
+    @signal_handlers.keys.each do |signal|
       Signal.trap(signal) do
-        @@signal_handlers[signal].each do |proc|
+        @signal_handlers[signal].each do |proc|
           proc.call(signal)
         end
       end
@@ -20,15 +20,15 @@ class SmallCage::Application
   end
 
   def self.add_signal_handler(signal, handler)
-    init_signal_handlers if @@signal_handlers.nil?
+    init_signal_handlers if @signal_handlers.nil?
     signal.to_a.each do |s|
-      @@signal_handlers[s] << handler
+      @signal_handlers[s] << handler
     end
   end
 
   def self.execute
     STDOUT.sync = true
-    self.new.execute
+    new.execute
   end
 
   def execute(argv = ARGV)
@@ -37,230 +37,6 @@ class SmallCage::Application
   end
 
   def parse_options(argv)
-    @argv = argv
-    @options = {}
-
-    @parser = create_main_parser
-    parse_main_options
-
-    @command_parsers = create_command_parsers
-    parse_command
-    parse_command_options
-
-    @options
-  end
-
-  def create_main_parser
-    parser = OptionParser.new
-    parser.banner =<<BANNER
-Usage: #{File.basename($0)} [options] <subcommand> [subcommand-options]
-#{VERSION_NOTE}
-Subcommands are:
-    update [path]                    Build smc contents.
-    clean  [path]                    Remove files generated from *.smc source.
-    server [path] [port]             Start HTTP server.
-    auto   [path] [port] [--bell]    Start auto update server.
-    import [name|uri]                Import project.
-    export [path] [outputpath]       Export project.
-    uri    [path]                    Print URIs.
-    manifest [path]                  Generate Manifest.html file.
-
-BANNER
-
-    parser.separator "Options are:"
-    parser.on("-h", "--help", "Show this help message.") do
-      puts parser
-      exit(true)
-    end
-    parser.on("-v", "--version", "Show version info.") do
-      puts VERSION_NOTE
-      exit(true)
-    end
-
-    @options[:quiet] = false
-    parser.on("-q", "--quiet", "Do not print message.") do |boolean|
-      @options[:quiet] = boolean
-    end
-
-    return parser
-  end
-  private :create_main_parser
-
-  def parse_main_options
-    @parser.order!(@argv)
-  rescue OptionParser::InvalidOption => e
-    $stderr.puts e.message
-    exit(false)
-  end
-  private :parse_main_options
-
-  def create_command_parsers
-    banners = {
-      :update => <<EOT,
-smc update [path] [options]
-    path : target directory. (default:'.')
-EOT
-
-      :clean  => <<EOT,
-smc clean [path] [options]
-    path : target directory (default:'.')
-EOT
-
-      :server => <<EOT,
-smc server [path] [port] [options]
-    path : target directory (default:'.')
-    port : HTTP server port number (default:8080)
-EOT
-
-      :auto   => <<EOT,
-smc auto [path] [port] [options]
-    path : target directory (default:'.')
-    port : HTTP server port number (default:don't launch the server)
-EOT
-
-      :import => <<EOT,
-smc import [name|uri] [options]
-EOT
-
-      :export => <<EOT,
-smc export [path] [outputpath] [options]
-EOT
-
-      :help   => <<EOT,
-smc help [command]
-EOT
-
-      :uri    => <<EOT,
-smc uri [path] [options]
-EOT
-
-      :manifest => <<EOT,
-smc manifest [path] [options]
-EOT
-
-    }
-
-    parsers = {}
-    banners.each do |command, banner|
-      parsers[command] = create_default_command_parser(banner)
-    end
-
-    parsers[:auto].on("--bell", "Ring bell after publishing files.") do |boolean|
-      @options[:bell] = boolean
-    end
-
-    return parsers
-  end
-  private :create_command_parsers
-
-  def create_default_command_parser(banner)
-    parser = OptionParser.new
-    parser.banner = "Usage: " + banner
-    parser.separator "Options are:"
-
-    # these options can place both before and after the subcommand.
-    parser.on("-h", "--help", "Show this help message.") do
-      puts parser
-      exit(true)
-    end
-    parser.on("-v", "--version", "Show version info.") do
-      puts VERSION_NOTE
-      exit(true)
-    end
-    parser.on("-q", "--quiet", "Do not print message.") do |boolean|
-      @options[:quiet] = boolean
-    end
-
-    return parser
-  end
-  private :create_default_command_parser
-
-  def parse_command
-    @options[:command] = get_command
-
-    if @options[:command].nil?
-      puts @parser
-      exit(false)
-    end
-    parser = @command_parsers[@options[:command]]
-    if parser.nil?
-      $stderr.puts "no such subcommand: #{@options[:command]}"
-      exit(false)
-    end
-    parser.parse!(@argv)
-  rescue OptionParser::InvalidOption => e
-    $stderr.puts e.message
-    exit(false)
-  end
-  private :parse_command
-
-
-  def get_command
-    commands = Hash.new {|h,k| k}
-    commands.merge!({
-      :up => :update,
-      :sv => :server,
-      :au => :auto,
-    })
-
-    command_name = @argv.shift.to_s.strip
-    return nil if command_name.empty?
-    return commands[command_name.to_sym]
-  end
-  private :get_command
-
-  def parse_command_options
-    if @options[:command] == :help
-      subcmd = @argv.shift
-      if subcmd.nil?
-        puts @parser
-      else
-        puts @command_parsers[subcmd.to_sym]
-      end
-      exit(true)
-    elsif @options[:command] == :update
-      @options[:path] = @argv.shift
-      @options[:path] ||= "."
-    elsif @options[:command] == :server
-      @options[:path] = @argv.shift
-      @options[:path] ||= "."
-      @options[:port] = get_port_number(8080)
-    elsif @options[:command] == :auto
-      @options[:path] = @argv.shift
-      @options[:path] ||= "."
-      @options[:port] = get_port_number(nil)
-      @options[:bell] ||= false
-    elsif @options[:command] == :import
-      @options[:from] = @argv.shift
-      @options[:from] ||= "default"
-      @options[:to] = @argv.shift
-      @options[:to] ||= "."
-    elsif @options[:command] == :export
-      @options[:path] = @argv.shift
-      @options[:path] ||= "."
-      @options[:out] = @argv.shift
-    elsif @options[:command] == :uri
-      @options[:path] = @argv.shift
-      @options[:path] ||= "."
-    elsif @options[:command] == :manifest
-      @options[:path] = @argv.shift
-      @options[:path] ||= "."
-    elsif @options[:command] == :clean
-      @options[:path] = @argv.shift
-      @options[:path] ||= "."
-    end
-  end
-  private :parse_command_options
-
-  def get_port_number(default)
-    return default if @argv.empty?
-
-    port = @argv.shift
-    if port.to_i == 0
-      $stderr.puts "illegal port number: #{port}"
-      exit(false)
-    end
-    return port.to_i
+    SmallCage::OptionsParser.new(argv).parse
   end
-  private :get_port_number
 end

data/lib/smallcage/commands/auto.rb

@@ -1,13 +1,31 @@
 module SmallCage::Commands
+  #
+  # 'smc auto' command
+  #
   class Auto < SmallCage::Commands::Base
-
     def initialize(opts)
       super(opts)
       @target = Pathname.new(opts[:path])
       @port = opts[:port]
       @sleep = 1
-      @mtimes = {}
+      @timestamps = {}
+    end
+
+    def load_initial_timestamps
+      # load timestamps
+      modified_special_files
+      modified_files
+
+      # overwrite @timestamps using list.yml to recover last update state.
+      list = SmallCage::UpdateList.create(@loader.root, @target)
+
+      list.mtimes.each do |uri, mtime|
+        path = @loader.root + ".#{uri}"
+        mtime = Time.at(mtime)
+        @timestamps[path] = mtime
+      end
     end
+    private :load_initial_timestamps
 
     def execute
       puts_banner
@@ -22,7 +40,12 @@ module SmallCage::Commands
       while @update_loop
         if first_loop
           first_loop = false
-          update_target
+          if @opts[:fast]
+            load_initial_timestamps
+            update_modified_files
+          else
+            update_target
+          end
         else
           update_modified_files
         end
@@ -35,17 +58,17 @@ module SmallCage::Commands
 
       result = []
       Dir.chdir(root) do
-        Dir.glob("_smc/{templates,filters,helpers}/*") do |f|
+        Dir.glob('_smc/{templates,filters,helpers}/*') do |f|
           f = root + f
           mtime = File.stat(f).mtime
-          if @mtimes[f] != mtime
-            @mtimes[f] = mtime
+          if @timestamps[f] != mtime
+            @timestamps[f] = mtime
             result << f
           end
         end
       end
 
-      return result
+      result
     end
     private :modified_special_files
 
@@ -53,27 +76,27 @@ module SmallCage::Commands
       result = []
       @loader.each_smc_file do |f|
         mtime = File.stat(f).mtime
-        if @mtimes[f] != mtime
-          @mtimes[f] = mtime
+        if @timestamps[f] != mtime
+          @timestamps[f] = mtime
           result << f
         end
       end
-      return result
+      result
     end
     private :modified_files
 
     def update_target
-      # load @mtimes
+      # load timestamps
       modified_special_files
       target_files = modified_files
 
-      runner = SmallCage::Runner.new({ :path => @target, :quiet => @opts[:quiet] })
+      runner = SmallCage::Runner.new(:path => @target, :quiet => @opts[:quiet])
       begin
         runner.update
       rescue Exception => e
         STDERR.puts e.to_s
         STDERR.puts $@[0..4].join("\n")
-        STDERR.puts ":"
+        STDERR.puts ':'
       end
 
       update_http_server(target_files)
@@ -88,22 +111,22 @@ module SmallCage::Commands
         target_files = modified_files
       else
         # update root directory.
-        target_files = [@loader.root + "./_dir.smc"]
+        target_files = [@loader.root + './_dir.smc']
         reload = true
       end
 
       return if target_files.empty?
       target_files.each do |tf|
-        if tf.basename.to_s == "_dir.smc"
-          runner = SmallCage::Runner.new({ :path => tf.parent, :quiet => @opts[:quiet] })
+        if tf.basename.to_s == '_dir.smc'
+          runner = SmallCage::Runner.new(:path => tf.parent, :quiet => @opts[:quiet])
         else
-          runner = SmallCage::Runner.new({ :path => tf, :quiet => @opts[:quiet] })
+          runner = SmallCage::Runner.new(:path => tf, :quiet => @opts[:quiet])
         end
         runner.update
       end
 
       if reload
-        @http_server.reload
+        @http_server.reload if @http_server
       else
         update_http_server(target_files)
       end
@@ -112,7 +135,7 @@ module SmallCage::Commands
     rescue Exception => e
       STDERR.puts e.to_s
       STDERR.puts $@[0..4].join("\n")
-      STDERR.puts ":"
+      STDERR.puts ':'
       puts_line
       notify
       notify
@@ -121,7 +144,7 @@ module SmallCage::Commands
 
     def puts_banner
       return if quiet?
-      puts "SmallCage Auto Update"
+      puts 'SmallCage Auto Update'
       puts "http://localhost:#{@port}/_smc/auto" unless @port.nil?
       puts
     end
@@ -129,7 +152,7 @@ module SmallCage::Commands
 
     def puts_line
       return if quiet?
-      puts "-" * 60
+      puts '-' * 60
     end
     private :puts_line
 
@@ -141,7 +164,7 @@ module SmallCage::Commands
 
     def update_http_server(target_files)
       return unless @http_server
-      path = target_files.find {|p| p.basename.to_s != "_dir.smc" }
+      path = target_files.find { |p| p.basename.to_s != '_dir.smc' }
       if path.nil?
         dir = target_files.shift
         dpath = SmallCage::DocumentPath.new(@loader.root, dir.parent)
@@ -158,7 +181,7 @@ module SmallCage::Commands
         @http_server.shutdown unless @http_server.nil?
         @update_loop = false
       end
-      SmallCage::Application.add_signal_handler(["INT", "TERM"], shutdown_handler)
+      SmallCage::Application.add_signal_handler(%w{INT TERM}, shutdown_handler)
     end
     private :init_sig_handler
 

data/lib/smallcage/commands/base.rb

@@ -1,7 +1,10 @@
 module SmallCage::Commands
+  #
+  # smc commands base class
+  #
   class Base
     def self.execute(opts)
-      self.new(opts).execute
+      new(opts).execute
     end
 
     def initialize(opts)
@@ -12,7 +15,7 @@ module SmallCage::Commands
     end
 
     def quiet?
-      return @opts[:quiet]
+      @opts[:quiet]
     end
   end
 end

data/lib/smallcage/commands/clean.rb

@@ -1,7 +1,10 @@
 module SmallCage::Commands
+  #
+  # 'smc clean' command
+  #
   class Clean
     def self.execute(opts)
-      self.new(opts).execute
+      new(opts).execute
     end
 
     def initialize(opts)
@@ -13,9 +16,7 @@ module SmallCage::Commands
       count = 0
 
       target = Pathname.new(@opts[:path])
-      unless target.exist?
-        raise "target directory or file does not exist.: " + target.to_s
-      end
+      fail 'target directory or file does not exist.: ' + target.to_s unless target.exist?
 
       loader = SmallCage::Loader.new(target)
       root = loader.root
@@ -30,16 +31,16 @@ module SmallCage::Commands
         end
       end
 
-      tmpdir = root + "_smc/tmp"
+      tmpdir = root + '_smc/tmp'
       if tmpdir.exist?
         FileUtils.rm_r(tmpdir)
-        puts "D /_smc/tmp" unless @opts[:quiet]
+        puts 'D /_smc/tmp' unless @opts[:quiet]
         count += 1
       end
 
       elapsed  = Time.now - start
-      puts "-- #{count} files.  #{"%.3f" % elapsed} sec." +
-        "  #{"%.3f" % (count == 0 ? 0 : elapsed/count)} sec/file." unless @opts[:quiet]
+      puts "-- #{ count } files.  #{ sprintf('%.3f', elapsed) } sec." +
+        "  #{ sprintf('%.3f', count == 0 ? 0 : elapsed / count) } sec/file." unless @opts[:quiet]
     end
   end
 end

data/lib/smallcage/commands/export.rb

@@ -2,40 +2,35 @@ module SmallCage::Commands
   class Export < SmallCage::Commands::Base
     def execute
       target = Pathname.new(@opts[:path])
-      unless target.exist?
-        raise target.to_s + " does not exist."
-      end
+      fail target.to_s + ' does not exist.' unless target.exist?
 
       loader = SmallCage::Loader.new(target)
       root = loader.root
 
       if @opts[:out].nil?
-        out = root + ("./_smc/tmp/export/" + Time.now.strftime("%Y%m%d%H%M%S"))
+        out = root + ('./_smc/tmp/export/' + Time.now.strftime('%Y%m%d%H%M%S'))
       else
         out = Pathname.new(@opts[:out])
       end
-      if out.exist?
-        raise out.to_s + " already exist."
-      end
+      fail out.to_s + ' already exist.' if out.exist?
+
       FileUtils.makedirs(out)
       out = out.realpath
 
-      # TODO create empty directories
+      # TODO: create empty directories
       loader.each_not_smc_file do |docpath|
         dir = Pathname.new(docpath.uri).parent
-        outdir = out + ("." + dir.to_s)
+        outdir = out + ('.' + dir.to_s)
         FileUtils.makedirs(outdir)
         FileUtils.cp(docpath.path, outdir)
-        puts "A " + docpath.uri unless quiet?
+        puts 'A ' + docpath.uri unless quiet?
       end
 
       unless quiet?
-        puts ""
-        puts "All contents exported to:"
+        puts ''
+        puts 'All contents exported to:'
         puts " #{out.to_s}"
       end
-
     end
-
   end
 end