roger 0.12.5 → 0.13.0

checksums.yaml

@@ -1,15 +1,15 @@
 ---
 !binary "U0hBMQ==":
   metadata.gz: !binary |-
-    Y2JmMWYxYzdhOWI1YjhiMzU4MmI2YjJhYWYyN2JhZmNmZmMyYjZjZA==
+    NTVmODQzZjA1Nzg0OGZmZWIzYmEwNDA4MGVlMjgxZWUzMjI5Njg2Yw==
   data.tar.gz: !binary |-
-    NDBkZDVmMmEzNzNhZDUyODk2Njg0MGJhYzcwZDA0NzE3YTQ0MWFlNg==
+    ZWM0NjJiYjYzYzNmZWFmODdmMDM0MmM5ZmQxMmY1MjgyZDBjZGNkMw==
 SHA512:
   metadata.gz: !binary |-
-    NjZlNjYxNTU4OTA4NDdkNTM1MjJkZWQ2MmY0YTVmMjUzY2Q0M2NkZWQ3MDIw
-    YTUxNzRlMTMyNzFmZmJmMmJiNTM4NGI0NmJjZjhmZTE5OWY4N2M0NDBhYzNk
-    NzU2MTM4ZGJkOThhNDdiYTZkYjQ1Y2FlODQ5M2U2MmJmNmM1MzQ=
+    NDdmYTEzNDRlMWY3ZmQwNjU1NjcxYzY3NTJlZDk4M2QwNjUwMzE3MTE0MmJj
+    MzMxZTQxOTBhYTI1ZmVkNzQ4YmFlZjAyZDY0OGIzODkyMDBmYmMwZjMyMGQ3
+    ODQ1ZTdiYjliZjczMjEwYmQ4NTlkMTlkNzg4YTcwNWE0ZjllODE=
   data.tar.gz: !binary |-
-    MmMxOTY1NDFlMjMzYWViOTcyYTE2ODM1M2E2MjBiZWNkMDY5N2JkY2Q2MjZj
-    N2JmMGI5ZmI0MWVjZDg0YzVlMTk2ZTI4ZDhhMmVhZjY2Njc4ZmY1MDNiNjQ0
-    MDM0NGZhMzBkZmI1MTJlZjQwNmJlNDI5N2ViNzI2ZTBlNzY0ODM=
+    YTVhYzQyMTg0MzkxM2JmNmU0ZTQ3YjlmYTBkNzUyNGJjZjk0MmVhZDExNmI4
+    MjRhOWJjNWRhMmY2OTg0ODIwODhjYjQyMTQyYTQ5ZDdmNWRiMDAzZGYxMzEw
+    ZTIzMWMzOWE5YjA4YzE1OGE3NjRmMGRkYzgzMTYxNzQ1NTZlMjA=

data/CHANGELOG.md

@@ -1,5 +1,14 @@
 # Changelog
 
+## Version 0.13.0
+*Attention* This is the last call version before 1.0.0 (5 years in sub 1.0.0 is more than enough)
+
+There should be no breaking changes between 0.12.5 and 0.13.0
+
+* Added `test` command infrastructure inlcuding tests
+* Remove W3C Validator, it is now available as a separate gem (`roger_w3cvalidator`)
+* Minor internal refactorings and library updates (mainly Thor and Test-Unit)
+
 ## Version 0.12.5
 * Fix github pages finalizer to work if the Dir finalizer is loaded as well
 * Run relativizer as the last thing before you finalize as to fix resolving issues with generated files

data/lib/roger/cli.rb

@@ -15,7 +15,6 @@ include FileUtils
 
 require File.dirname(__FILE__) + "/template"
 require File.dirname(__FILE__) + "/project"
-require File.dirname(__FILE__) + "/w3c_validator"
 
 
 module Roger
@@ -26,8 +25,10 @@ require File.dirname(__FILE__) + "/cli/command"
 require File.dirname(__FILE__) + "/cli/serve"
 require File.dirname(__FILE__) + "/cli/release"
 require File.dirname(__FILE__) + "/cli/generate"
+require File.dirname(__FILE__) + "/cli/test"
 
 require File.dirname(__FILE__) + "/generators"
+require File.dirname(__FILE__) + "/test"
 
 
 module Roger
@@ -35,11 +36,15 @@ module Roger
 
     def initialize(*args)
       super
-      self.class.project = initialize_project
+      self.class.project ||= initialize_project
     end
 
     class << self
       attr_accessor :project
+
+      def exit_on_failure?
+        true
+      end
     end
 
     class_option :path, 
@@ -57,7 +62,11 @@ module Roger
       :desc => 'Defaults to [directory]/partials',
       :type => :string
     
-    register Cli::Generate, "generate", "generate [COMMAND]", "Run a generator"
+    desc "test [COMMAND]", "Run one or more tests. Test can be 'all' for all defined tests or a specific test name"
+    subcommand "test", Cli::Test
+
+    desc "generate [COMMAND]", "Run a generator"
+    subcommand "generate", Cli::Generate
 
     register Cli::Serve, "serve", "serve #{Cli::Serve.arguments.map{ |arg| arg.banner }.join(" ")}", Cli::Serve.desc
     self.tasks["serve"].options = Cli::Serve.class_options
@@ -65,36 +74,6 @@ module Roger
     register Cli::Release, "release", "release #{Cli::Release.arguments.map{ |arg| arg.banner }.join(" ")}", Cli::Release.desc
     self.tasks["release"].options = Cli::Release.class_options
     
-    desc "validate [directory/file]", "Validates the file or all HTML in directory"
-    method_options :show_valid => :boolean, # Also print a line for each valid file
-                   :filter => :string # What files should be found, defaults to [^_]*.html
-    def validate(path=".")
-      filter = options["filter"] || "[^_]*.html"
-      
-      puts "Filtering on #{options["filter"]}" if options["filter"]
-      
-      if File.directory?(path)
-        any_invalid = false
-        
-        if (files = Dir.glob("#{path}/**/#{filter}")).any?
-        	files.each do |file|
-        		if !self.w3cvalidate(file)
-        		  any_invalid = true
-        	  end
-        	end
-        	if !any_invalid
-        	  puts "All files were considered valid"
-          end
-        else
-          puts "No files matched \"#{filter}\""
-        end
-      elsif File.readable?(path)
-        self.w3cvalidate(path)
-      else
-        puts "No such file/directory #{path}"
-      end      
-    end
-    
     protected
 
     # TODO: handle options
@@ -106,17 +85,6 @@ module Roger
       
       Project.new(options[:path], {:shell => self.shell}.update(options))
     end
-
-    
-    def w3cvalidate(file)
-      validator = W3CValidator.new(File.read(file))
-      validator.validate!  
-      if !options["show_valid"] && !validator.valid || options["show_valid"]
-        print "- #{file} "    
-        print "(errors: #{validator.errors}, warnings: #{validator.warnings})\n"
-      end
-      validator.valid
-    end
  
   end
 

data/lib/roger/cli/command.rb

@@ -1,13 +1,17 @@
 module Roger
 
   class Cli::Command < Thor::Group
-
+    def self.exit_on_failure?
+      true
+    end
+    
     class_option :verbose,
       :desc =>  "Set's verbose output",
       :aliases => ["-v"],
       :default => false,
       :type => :boolean
 
+
     def initialize_project
       @project = Cli::Base.project
     end

data/lib/roger/cli/generate.rb

@@ -1,5 +1,7 @@
 module Roger
   class Cli::Generate < Thor
-
+    def self.exit_on_failure?
+      true
+    end
   end
 end

data/lib/roger/cli/test.rb

@@ -0,0 +1,16 @@
+module Roger
+  class Cli::Test < Thor
+    def self.exit_on_failure?
+      true
+    end
+
+    default_task :all    
+
+    desc "all", "Run all tests defined in Mockupfile. (this is the default action)"
+    def all
+      unless Cli::Base.project.test.run!
+        raise Thor::Error, "Test failed"
+      end
+    end
+  end
+end

data/lib/roger/helpers/get_callable.rb

@@ -0,0 +1,28 @@
+module Roger
+  module Helpers
+    module GetCallable
+      # Makes callable into a object that responds to call. 
+      #
+      # @param [#call, Symbol, Class] callable If callable already responds to #call will just return callable, a Symbol will be searched for in the scope parameter, a class will be instantiated (and checked if it will respond to #call)
+      # @param [Hash] map, Mapping to match symbol to a callable
+      def get_callable(callable, map)
+        return callable if callable.respond_to?(:call)
+      
+        if callable.kind_of?(Symbol) && map.has_key?(callable)
+          callable = map[callable]
+        end
+      
+        if callable.kind_of?(Class)
+          callable = callable.new
+        end
+      
+        if callable.respond_to?(:call)
+          callable
+        else
+          raise ArgumentError, "Could not resolve #{callable.inspect}. Callable must be an object that responds to #call or a symbol that resolve to such an object or a class with a #call instance method."
+        end
+      
+      end
+    end
+  end
+end

data/lib/roger/helpers/logging.rb

@@ -0,0 +1,30 @@
+module Roger
+  module Helpers
+    module Logging
+      # Write out a log message
+      def log(part, msg, verbose = false, &block)
+        if !verbose || verbose && self.project.options[:verbose]
+          self.project.shell.say "\033[37m#{part.class.to_s}\033[0m" + " : " + msg.to_s, nil, true
+        end
+        if block_given?
+          begin
+            self.project.shell.padding = self.project.shell.padding + 1
+            yield
+          ensure
+            self.project.shell.padding = self.project.shell.padding - 1
+          end
+        end
+      end
+      
+      def debug(part, msg, &block)
+        self.log(part, msg, true, &block)
+      end
+      
+      # Write out a warning message
+      def warn(part, msg)
+        self.project.shell.say "\033[37m#{part.class.to_s}\033[0m" + " : " + "\033[31m#{msg.to_s}\033[0m", nil, true
+      end
+      
+    end
+  end
+end

data/lib/roger/mockupfile.rb

@@ -23,9 +23,9 @@ module Roger
     # @attr :path [Pathname] The path of the Mockupfile for this project
     attr_accessor :path, :project
         
-    def initialize(project)
+    def initialize(project, path = nil)
       @project = project
-      @path = Pathname.new(project.path + "Mockupfile")
+      @path = (path && Pathname.new(path)) || Pathname.new(project.path + "Mockupfile")
     end
 
     # Actually load the mockupfile
@@ -56,8 +56,15 @@ module Roger
       end
       self.project.server      
     end
-    
+
     alias :server :serve
+
+    def test
+      if block_given?
+        yield(self.project.test)
+      end
+      self.project.test
+    end
     
   end
 end

data/lib/roger/project.rb

@@ -1,5 +1,7 @@
 require File.dirname(__FILE__) + "/release"
 require File.dirname(__FILE__) + "/server"
+require File.dirname(__FILE__) + "/test"
+
 require File.dirname(__FILE__) + "/mockupfile"
 
 module Roger
@@ -10,7 +12,8 @@ module Roger
     # @attr :html_path [Pathname] The path of the HTML mockup
     # @attr :partial_path [Pathname] The path for the partials for this mockup
     # @attr :mockupfile [Mockupfile] The Mockupfile for this project
-    attr_accessor :path, :html_path, :partial_path, :layouts_path, :mockupfile
+    # @attr :mockupfile_path [Pathname] The path to the Mockupfile
+    attr_accessor :path, :html_path, :partial_path, :layouts_path, :mockupfile, :mockupfile_path
     
     attr_accessor :shell
     
@@ -22,7 +25,8 @@ module Roger
       @options = {
         :html_path => @path + "html",
         :partial_path => @path + "partials",
-        :layouts_path => @path + "layouts"
+        :layouts_path => @path + "layouts",
+        :mockupfile_path => @path + "Mockupfile"
       }
       
       # Clumsy string to symbol key conversion
@@ -31,9 +35,16 @@ module Roger
       self.html_path = @options[:html_path]
       self.partial_path = @options[:partials_path] || @options[:partial_path] || self.html_path + "../partials/"
       self.layouts_path = @options[:layouts_path]
+      self.mockupfile_path = @options[:mockupfile_path]
       self.shell = @options[:shell]
       
-      load_mockup!
+      if self.mockupfile_path
+        @mockupfile = Mockupfile.new(self, self.mockupfile_path)
+        @mockupfile.load
+      else
+        @mockupfile = Mockupfile.new(self)
+      end
+
     end
     
     def shell
@@ -49,6 +60,11 @@ module Roger
       options = @options[:release] || {}      
       @release ||= Release.new(self, options)
     end
+
+    def test
+      options = @options[:test] || {}
+      @test ||= Test.new(self, options)
+    end
     
     def html_path=(p)
       @html_path = self.realpath_or_path(p)
@@ -66,11 +82,6 @@ module Roger
     
     protected
 
-    def load_mockup!
-      @mockupfile = Mockupfile.new(self)
-      @mockupfile.load      
-    end
-
     def single_or_multiple_paths(p)
       if p.kind_of?(Array)
         p.map{|tp| self.realpath_or_path(tp) }

data/lib/roger/release.rb

@@ -1,14 +1,18 @@
 require File.dirname(__FILE__) + "/cli"
+require File.dirname(__FILE__) + "/helpers/get_callable"
+require File.dirname(__FILE__) + "/helpers/logging"
 
 module Roger
   class Release
+    include Roger::Helpers::Logging
 
     attr_reader :config, :project
 
     attr_reader :finalizers, :injections, :stack, :cleanups
 
     class << self
-
+     include Roger::Helpers::GetCallable
+      
       def default_stack
         []
       end
@@ -17,28 +21,6 @@ module Roger
         [[self.get_callable(:dir, Roger::Release::Finalizers.map), {}]]
       end
 
-      # Makes callable into a object that responds to call.
-      #
-      # @param [#call, Symbol, Class] callable If callable already responds to #call will just return callable, a Symbol will be searched for in the scope parameter, a class will be instantiated (and checked if it will respond to #call)
-      # @param [Hash] map, Mapping to match symbol to a callable
-      def get_callable(callable, map)
-        return callable if callable.respond_to?(:call)
-
-        if callable.kind_of?(Symbol) && map.has_key?(callable)
-          callable = map[callable]
-        end
-
-        if callable.kind_of?(Class)
-          callable = callable.new
-        end
-
-        if callable.respond_to?(:call)
-          callable
-        else
-          raise ArgumentError, "Could not resolve #{callable.inspect}. Callable must be an object that responds to #call or a symbol that resolve to such an object or a class with a #call instance method."
-        end
-
-      end
     end
 
     # @option config [Symbol] :scm The SCM to use (default = :git)
@@ -204,34 +186,10 @@ module Roger
 
       # Cleanup
       cleanup! if self.config[:cleanup_build]
-
-    end
-
-    # Write out a log message
-    def log(part, msg, verbose = false, &block)
-      if !verbose || verbose && self.project.options[:verbose]
-        self.project.shell.say "\033[37m#{part.class.to_s}\033[0m" + " : " + msg.to_s, nil, true
-      end
-      if block_given?
-        begin
-          self.project.shell.padding = self.project.shell.padding + 1
-          yield
-        ensure
-          self.project.shell.padding = self.project.shell.padding - 1
-        end
-      end
-    end
-
-    def debug(part, msg, &block)
-      self.log(part, msg, true, &block)
-    end
-
-    # Write out a warning message
-    def warn(part, msg)
-      self.project.shell.say "\033[37m#{part.class.to_s}\033[0m" + " : " + "\033[31m#{msg.to_s}\033[0m", nil, true
-    end
-
-
+      
+    end    
+    
+    
     # @param [Array] globs an array of file path globs that will be globbed against the build_path
     # @param [Array] excludes an array of regexps that will be excluded from the result
     def get_files(globs, excludes = [])

data/lib/roger/release/finalizers/rsync.rb

@@ -43,9 +43,7 @@ module Roger::Release::Finalizers
         
         local_path += "/" unless local_path =~ /\/\Z/
         remote_path += "/" unless remote_path =~ /\/\Z/
-
-        self.add_htaccess(release, options) if options[:htaccess]
-
+        
         release.log(self, "Starting upload of #{(release.build_path + "*")} to #{options[:host]}")
       
         command = "#{options[:rsync]} -az #{Shellwords.escape(local_path)} #{Shellwords.escape(options[:username])}@#{Shellwords.escape(options[:host])}:#{Shellwords.escape(remote_path)}"
@@ -61,24 +59,6 @@ module Roger::Release::Finalizers
     end
     
     protected
-
-    def add_htaccess(release, options)
-      remote_htaccess_path = File.join(options[:remote_path], ".htaccess")
-      remote_htpasswd_path = File.join(options[:remote_path], ".htpasswd")
-      local_path = release.build_path
-
-      shell = release.project.shell
-
-      # Get the remote file
-      command = "#{options[:rsync]} #{Shellwords.escape(options[:username])}@#{Shellwords.escape(options[:host])}:#{Shellwords.escape(remote_htaccess_path)} :#{Shellwords.escape(remote_htpasswd_path)} #{Shellwords.escape(local_path)}"
-
-      if File.exist?(local_path + ".htaccess") && File.exist?(local_path + ".htpasswd")
-        release.log(self, ".htaccess and .htpasswd already exist")
-      else
-
-      end
-
-    end
     
     def validate_options!(release, options)
       must_have_keys = [:remote_path, :host, :username]
@@ -96,38 +76,4 @@ module Roger::Release::Finalizers
   end
 end
 
-Roger::Release::Finalizers.register(:rsync, Roger::Release::Finalizers::Rsync)
-
-
-# 1. Check option :htaccess => true
-# 2. Check if remote file exists (.htaccess)
-
-# 3. If it doesn't
-# 4. Ask what the authname should be.
-# 4. Ask if you want IP restriction
-# 5. Ask if you want to add your own IP
-# 6. Ask for other IPs
-# 7. Ask if you want PW restriction
-# 8. Ask for username
-# 9. Ask for password (or Enter to generate)
-# 10. Upload .htaccess
-# 11. Upload .htpasswd
-
-# 3. If it does
-# 4. Output available users & ip's with access?
-
-
-# AuthName "DNB Referentiesite"
-# AuthType Basic
-# AuthUserFile /home/users/entopic/vhome/entopic.com/dnb-referentie/.htpasswd
-# Require valid-user
-# Order deny,allow
-# Deny from all
-# Allow from 31.223.173.138 # Kantoor DP
-# Satisfy Any
-
-# <FilesMatch "\.(htaccess|htpasswd)$">
-#  Order Allow,Deny
-#  Deny from all
-# </FilesMatch>
-
+Roger::Release::Finalizers.register(:rsync, Roger::Release::Finalizers::Rsync)