roger 1.0.1 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 5e0f86b2900d47b937fc8dfb690db21c77872639
-  data.tar.gz: 60c2e435b91fd529cf336117bdcb14150275c742
+  metadata.gz: 28dd28041cfcd471cf9ced59eb34fc583da7e8d7
+  data.tar.gz: 3728b68fa1fdbfacca3baf14fdf9ad3ccae869bf
 SHA512:
-  metadata.gz: 23e28a30047b8822944a568d6ecf48cdf32ddc56ef8aad5316d275edce910f5cef21293d96b57bba3a535a3d518c8ecdd2427c43b2bc12e285ee8b3db6181330
-  data.tar.gz: 0beb01fdac08535e30f380f0650ff29c8b44228bbf8f20f4635ea991c226020a4d21e8a7110157e292bcb818759622ec732df7e2de1e7887dcf1e8c5726dce2a
+  metadata.gz: 1b6d9a19eacc627633c8770eeeade02241f4e9ce998d8fa7e4fda1ea661edf43cff1074901d4cec45a90092a2aaea81918269bf9ae39693674b0dc33c63b4417
+  data.tar.gz: 871ee889484649653e5b25e297d1754668179462648b53be74fd5783128dc36e4efa40f20b7dae75fd006c501ee9a86d43404c68c13c87cdbd711ecf3906ea51

data/CHANGELOG.md

@@ -1,5 +1,12 @@
 # Changelog
 
+## Version 1.1.0
+
+* Allow passing of options to release, test and server from Mockupfile
+* Add option to make blank releases by passing `blank: true`; a blank release will not automatically add default processors and finalizers. This is a non-breaking change, the default is blank: false
+* Add project.mode so we can infer what mode we're in (:test, :release, :server) when running processors, middleware, tests, ets.
+* Release now by default takes project path as root instead of PWD. If you rely on this behaviour you may want to pass your own path definitions in mockup.release(....).
+
 ## Version 1.0.1
 
 * Release copy command is now configurable by passing :cp configuration option to the mockup.release command in the mockup file. By default the release now uses system cp instead of fileutils cp so we can follow symlinks (you don't want symlinks in your release). If you want the old behaviour you have to pass {cp: nil}.

data/lib/roger/mockupfile.rb

@@ -43,27 +43,30 @@ module Roger
       @loaded
     end
 
-    def release
+    def release(options = {})
+      release = self.project.release(options)
       if block_given?
-        yield(self.project.release)
+        yield(release)
       end
-      self.project.release
+      release
     end
 
-    def serve
+    def serve(options = {})
+      server = self.project.server(options)
       if block_given?
-        yield(self.project.server)
+        yield(server)
       end
-      self.project.server
+      server
     end
 
     alias :server :serve
 
-    def test
+    def test(options = {})
+      test = self.project.test(options)
       if block_given?
-        yield(self.project.test)
+        yield(test)
       end
-      self.project.test
+      test
     end
 
   end

data/lib/roger/project.rb

@@ -13,7 +13,8 @@ module Roger
     # @attr :partial_path [Pathname] The path for the partials for this mockup
     # @attr :mockupfile [Mockupfile] The Mockupfile for this project
     # @attr :mockupfile_path [Pathname] The path to the Mockupfile
-    attr_accessor :path, :html_path, :partial_path, :layouts_path, :mockupfile, :mockupfile_path
+    # @attr :mode [nil, :test, :server, :release] The mode we're currently in. If nil, we aren't doing anything.
+    attr_accessor :path, :html_path, :partial_path, :layouts_path, :mockupfile, :mockupfile_path, :mode
 
     attr_accessor :shell
 
@@ -26,7 +27,10 @@ module Roger
         :html_path => @path + "html",
         :partial_path => @path + "partials",
         :layouts_path => @path + "layouts",
-        :mockupfile_path => @path + "Mockupfile"
+        :mockupfile_path => @path + "Mockupfile",
+        :server => {},
+        :release => {},
+        :test => {}
       }
 
       # Clumsy string to symbol key conversion
@@ -51,18 +55,18 @@ module Roger
       @shell ||= Thor::Base.shell.new
     end
 
-    def server
-      options = @options[:server] || {}
+    def server(options = {})
+      options = {}.update(@options[:server]).update(options)
       @server ||= Server.new(self, options)
     end
 
-    def release
-      options = @options[:release] || {}
+    def release(options = {})
+      options = {}.update(@options[:release]).update(options)
       @release ||= Release.new(self, options)
     end
 
-    def test
-      options = @options[:test] || {}
+    def test(options = {})
+      options = {}.update(@options[:test]).update(options)
       @test ||= Test.new(self, options)
     end
 

data/lib/roger/release.rb

@@ -10,7 +10,7 @@ module Roger
 
     attr_reader :config, :project
 
-    attr_reader :finalizers, :injections, :stack, :cleanups
+    attr_reader :finalizers, :stack
 
     class << self
      include Roger::Helpers::GetCallable
@@ -30,17 +30,20 @@ module Roger
     # @option config [String, Pathname]:build_path Temporary path used to build the release
     # @option config [Boolean] :cleanup_build Wether or not to remove the build_path after we're done (default = true)
     # @option config [Array,String, nil] :cp CP command to use; Array will be escaped with Shellwords. Pass nil to get native Ruby CP. (default = ["cp", "-RL"])
+    # @option config [Boolean] :blank Keeps the release clean, don't automatically add any processors or finalizers (default = false)
     def initialize(project, config = {})
       defaults = {
         :scm => :git,
-        :source_path  => Pathname.new(Dir.pwd) + "html",
-        :target_path => Pathname.new(Dir.pwd) + "releases",
-        :build_path => Pathname.new(Dir.pwd) + "build",
+        :source_path  => project.path + "html",
+        :target_path => project.path + "releases",
+        :build_path => project.path + "build",
         :cp => ["cp", "-RL"],
+        :blank => false,
         :cleanup_build => true
       }
 
       @config = {}.update(defaults).update(config)
+
       @project = project
       @stack = []
       @finalizers = []
@@ -174,6 +177,8 @@ module Roger
 
     # Actually perform the release
     def run!
+      project.mode = :release
+
       # Validate paths
       validate_paths!
 
@@ -190,7 +195,8 @@ module Roger
 
       # Cleanup
       cleanup! if self.config[:cleanup_build]
-
+    ensure
+      project.mode = nil
     end
 
 
@@ -227,7 +233,9 @@ module Roger
 
     # Checks if deprecated extractor options have been set
     # Checks if the mockup will be runned
+    # If config[:blank] is true it will automatically add UrlRelativizer or Mockup processor
     def validate_stack!
+      return if config[:blank]
 
       mockup_options = {}
       relativizer_options = {}
@@ -252,7 +260,7 @@ module Roger
 
       if self.config[:cp]
         command = [self.config[:cp]].flatten
-        system(Shellwords.join(command + ["#{self.source_path}/", self.build_path]))
+        system(Shellwords.join(command + ["#{self.source_path}/", self.build_path.to_s]))
       else
         cp_r(self.source_path.children, self.build_path)
       end
@@ -271,8 +279,12 @@ module Roger
       end
     end
 
+    # Will run all finalizers, if no finalizers are set it will take the
+    # default finalizers.
+    #
+    # If config[:blank] is true, it will not use the default finalizers
     def run_finalizers!
-      @finalizers = self.class.default_finalizers.dup if @finalizers.empty?
+      @finalizers = self.class.default_finalizers.dup if @finalizers.empty? && !config[:blank]
 
       # call all objects in @finalizes
       @finalizers.each do |finalizer|

data/lib/roger/server.rb

@@ -52,6 +52,7 @@ module Roger
     end
 
     def run!
+      project.mode = :server
       self.handler.run self.application, self.server_options do |server|
         trap(:INT) do
           ## Use thins' hard #stop! if available, otherwise just #stop
@@ -59,6 +60,8 @@ module Roger
           puts "Roger, out!"
         end
       end
+    ensure
+      project.mode = nil
     end
     alias :run :run!
 

data/lib/roger/test.rb

@@ -52,24 +52,28 @@ module Roger
 
     def initialize(project, config = {})
       defaults = {}
-      
+
       @config = {}.update(defaults).update(config)
       @project = project
       @stack = []
-    end    
+    end
 
-    # Use a certain test, this will also register it on the CLI
+    # Use a certain test, this will also register it on the CLI if you supply a symbol.
     #
     # @examples
     #   test.use :jshint, config
     def use(processor, options = {})
       test = self.class.get_callable(processor, Roger::Test.map)
-      self.register_in_cli(processor, @stack.size, self.class.cli_map[processor])
+      if processor.is_a?(Symbol)
+        self.register_in_cli(processor, @stack.size, self.class.cli_map[processor])
+      end
       @stack << [test, options]
     end
 
     # Run all tests and return true when succeeded
     def run!
+      project.mode = :test
+
       success = true
       @stack.each do |task|
         ret = call_test(task) # Don't put this on one line, you will fail... :)
@@ -77,13 +81,15 @@ module Roger
       end
 
       success
+    ensure
+      project.mode = nil
     end
 
     # Run a specific test by stack index.
     def run_test!(index)
       test = @stack[index]
       if test
-        call_test(test) 
+        call_test(test)
       else
         false
       end
@@ -119,7 +125,7 @@ module Roger
     def register_in_cli(name, stack_index, klass)
       long_desc = "Run #{name} tests"
 
-      if klass && klass.kind_of?(Class) && klass <= Roger::Test::Cli 
+      if klass && klass.kind_of?(Class) && klass <= Roger::Test::Cli
         usage = "#{name} #{klass.arguments.map{ |arg| arg.banner }.join(" ")}"
         thor_class = klass
       else

data/roger.gemspec

@@ -2,7 +2,7 @@
 
 Gem::Specification.new do |s|
   s.name = "roger"
-  s.version = "1.0.1"
+  s.version = "1.1.0"
 
   s.authors = ["Flurin Egger", "Edwin van der Graaf", "Joran Kapteijns"]
   s.email = ["info@digitpaint.nl", "flurin@digitpaint.nl"]

data/test/unit/release_test.rb

@@ -5,6 +5,34 @@ require "test/unit"
 module Roger
   class ReleaseTest < ::Test::Unit::TestCase
 
+    def setup
+      @project = Project.new(File.dirname(__FILE__) + "/../project", :mockupfile_path => false)
+      @mockupfile = Roger::Mockupfile.new(@project)
+    end
+
+
+    def test_run_should_set_project_mode
+      assert_equal @project.mode, nil
+
+      # Running a blank release
+      @mockupfile.release(:blank => true) do |r|
+        r.use Proc.new{|release|
+          assert_equal release.project.mode, :release
+        }
+      end
+
+      @project.release.run!
+      assert_equal @project.mode, nil
+    end
+
+    def test_blank_release_should_have_no_processors_and_finalizers
+      @mockupfile.release(:blank => true)
+      @project.release.run!
+
+      assert @project.release.stack.empty?
+      assert @project.release.finalizers.empty?
+    end
+
     def test_get_callable
       p = lambda{}
       assert_equal Release.get_callable(p, {}), p

data/test/unit/test_test.rb

@@ -9,6 +9,22 @@ module Roger
       @files = ["html/javascripts/site.js",
                 "html/vendor/underscore/underscore.js"]
       @globs = stub(map: @files)
+
+      @project = Project.new(File.dirname(__FILE__) + "/../project", :mockupfile_path => false)
+      @mockupfile = Roger::Mockupfile.new(@project)
+    end
+
+    def test_test_run_should_set_project_mode
+      assert_equal @project.mode, nil
+
+      @mockupfile.test do |t|
+        t.use Proc.new{|test|
+          assert_equal test.project.mode, :test
+        }
+      end
+
+      @project.test.run!
+      assert_equal @project.mode, nil
     end
 
     def test_get_files

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: roger
 version: !ruby/object:Gem::Version
-  version: 1.0.1
+  version: 1.1.0
 platform: ruby
 authors:
 - Flurin Egger
@@ -10,7 +10,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-05-18 00:00:00.000000000 Z
+date: 2015-05-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: thor