roger 1.3.5 → 1.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 933f5afa9f6bede1db36b2344edce2b0e088cdc0
-  data.tar.gz: 8ff81b43a2f3555a65866c74c4fe4ddb71380dc8
+  metadata.gz: 49a1a247ec24477695446f28ee9fc18303c679db
+  data.tar.gz: ec29ac61a0ea48418f81114a3826dbdf56ed3efd
 SHA512:
-  metadata.gz: 0c74286a83d50ec67361aeb9dedfac0d5562954874135f21bdd27f0c1c204a5215a7c28554405396b46e6c444231dfff60d733585acac489fe4bc70aba05bc0f
-  data.tar.gz: 3323b1f5612fd2d438492fc61000611bad8deb3f773e6f52187b42afe38bc5e5b6d9afacd03a9ca2ef103e41b0d79fc71b7bca14d0a272cd224703aa4061f566
+  metadata.gz: 256706c9c7e39642602d4dc33b85211b3ffb47889890e3334eaed3804331937ff4ffafb3fc8cb8d497daab234d847632d9986e8afadcffc19adad9be1b5510df
+  data.tar.gz: 2317f5b6140e265463ff6d797d2e2f103e33146ff1b22ef1a8184609ae168eb0c522f992d2176af94b5f896a3e1ed37874946bca70feef1dc16cb74a9a2f906b

data/CHANGELOG.md

@@ -1,7 +1,12 @@
 # Changelog
 
-## Version 1.3.5
-* Backmerge fix for `cp -RL` on linux
+## Version 1.4.0
+* Rename Mockupfile to Rogerfile
+* Remove the deprecated `Roger::Extractor` (use `Roger::Template` instead)
+* Add support for template helpers through `Roger::Template.register MyHelpersModule`
+* Add more documentation on templating
+* Comment method from Rogerfile will no longer add ! to js/css comments
+* Heavily increase test coverage
 
 ## Version 1.3.4
 * Require the correct "English" module (with capital E) for $CHILD_STATUS

data/README.md

@@ -25,7 +25,7 @@ We assume you have a working Ruby 1.9.x or higher running.
 1. Create a new project
 
     ```shell
-    mockup generate new PROJECT_DIR
+    roger generate new PROJECT_DIR
     ```
 
     Replace `PROJECT_DIR` with your project name
@@ -33,7 +33,7 @@ We assume you have a working Ruby 1.9.x or higher running.
 1. Start the development server
 
     ```shell
-    mockup serve
+    roger serve
     ```
 
     Open your webbrowser and go to `http://localhost:9000/`
@@ -41,7 +41,7 @@ We assume you have a working Ruby 1.9.x or higher running.
 1. Release your project
 
     ```shell
-    mockup release
+    roger release
     ```
 
 ## Where to go from here?
@@ -49,8 +49,8 @@ We assume you have a working Ruby 1.9.x or higher running.
 Read more documentation:
 
 * [**Templating** Learn the power of Roger built in templating](doc/templating.md)
-* [**CLI** Learn about the different `mockup` commands](doc/cli.md)
-* [**Mockupfile** Learn how to configure and extend your Project](doc/mockupfile.md)
+* [**CLI** Learn about the different `roger` commands](doc/cli.md)
+* [**Rogerfile** Learn how to configure and extend your Project](doc/rogerfile.md)
 
 ## Why?
 

data/doc/cli.md

@@ -3,25 +3,25 @@
 The easiest way to get help is through the commandline by running
 
 ```shell
-mockup help
+roger help
 ```
 
 or to get help on a specific subcommand
 
 ```shell
-mockup help [subcommand]
+roger help [subcommand]
 ```
 
 ## Generate
 
 ```shell
-mockup generate [generator] [options]
+roger generate [generator] [options]
 ```
 
 ## Serve
 
 ```shell
-mockup serve [options]
+roger serve [options]
 ```
 
 Starts a webserver (port 9000 by default)
@@ -30,7 +30,7 @@ Starts a webserver (port 9000 by default)
 ## Release
 
 ```shell
-mockup release [options]
+roger release [options]
 ```
 
 Releases the project
@@ -38,7 +38,7 @@ Releases the project
 ## Test
 
 ```shell
-mockup test [options]
+roger test [options]
 ```
 
 Tests the project

data/doc/{mockupfile.md → rogerfile.md}

@@ -1,6 +1,6 @@
-# Mockupfile
+# Rogerfile
 
-The mockupfile is where all the project configuration for releasing, serving etc. happens.
+The rogerfile is where all the project configuration for releasing, serving etc. happens.
 
 ## Example
 
@@ -12,23 +12,23 @@ Sass::Plugin.options[:template_location] = "./html/stylesheets"
 Sass::Plugin.options[:css_location] = "./html/stylesheets"
 
 # Set verbosity to true (you can also pass --verbose to roger)
-# mockup.project.options[:verbose] = true
+# roger.project.options[:verbose] = true
 
 # These are defaults, but can be set here
-# mockup.project.html_path = mockup.project.path + "html"
-# mockup.project.partial_path = mockup.project.path + "partials"
+# roger.project.html_path = roger.project.path + "html"
+# roger.project.partial_path = roger.project.path + "partials"
 
 # Server is a regular Rack interface.
-mockup.serve do |server|
+roger.serve do |server|
   server.use :sass
 end
 
 # Define tests
-mockup.test do |t|
+roger.test do |t|
   t.use :jshint
 end
 
-mockup.release do |release|
+roger.release do |release|
   
   # The variables below can be used anywhere in this section
   release.target_path # The target path where releases are put
@@ -40,8 +40,8 @@ mockup.release do |release|
   release.scm.version # Get the git version
   release.scm.date # Get the git date
 
-  # Extract mockup (this is optional)
-  # release.mockup
+  # Extract project (this is optional)
+  # release.use :mockup
 
   # Create custom banner
   #

data/doc/templating.md

@@ -4,7 +4,7 @@
 
 Before we get started, it's good to know that there are a couple of "special" folders within any Roger project. Don't worry, you can configure these; they're not hard-coded. The folders are:
 
-* **project-path** this is the main directory containing the Mockupfile and all other directories.
+* **project-path** this is the main directory containing the Rogerfile and all other directories.
 * **html-path** this is the directory where all your HTML/CSS/Javascript will go (in subdirectories of course).
 * **partials-path** this is the directory where all partials reside.
 * **layouts-path** this is the directory where the layouts hang out.
@@ -25,9 +25,9 @@ Only the html-path has to exist. The others are not required.
 
 ## HTML
 
-The html-path is actually the root for all you front-end code. This is what will be served as the document-root with `mockup serve` and will be the base for a release when using `mockup release`.
+The html-path is actually the root for all you front-end code. This is what will be served as the document-root with `roger serve` and will be the base for a release when using `roger release`.
 
-In the html-path you can put static files (images, documents, etc.) but also templates. Anything that the [Tilt Engine](https://github.com/rtomayko/tilt) can handle is ok. The only thing Mockup adds is handling for front-matter, layouts and partials. 
+In the html-path you can put static files (images, documents, etc.) but also templates. Anything that the [Tilt Engine](https://github.com/rtomayko/tilt) can handle is ok. The only thing Roger adds is handling for front-matter, layouts and partials. 
 
 ## Front-matter
 
@@ -44,10 +44,9 @@ these values in the templates (layouts and partials included) by using `document
 
 ## Layouts
 
-Layouts are basically "wrap" templates. The layout will wrap around the rendered template. In the template front-matter you define what layout it should use by setting the `layout` key.
-
-### An example
+Layouts are basically "wrap" templates. The layout will wrap around the rendered template. In the template front-matter you define what layout it should use by setting the `layout` key. See the example below.
 
+### Basic layout example
 
 #### html/template.html.erb
 ```erb
@@ -73,6 +72,45 @@ Template
 Layout (after)
 ```
 
+### Advanced layouts
+
+#### Using `content_for`
+
+You can have multiple regions in your layout. That way you can yield multiple times for each region. See the example below for usage on `content_for :name do ... end` and `yield :name`.
+
+##### `content_for` example
+
+###### html/template.html.erb
+```erb
+---
+layout: default
+---
+
+<% content_for :sidebar %>
+  Sidebar
+<% end %>
+
+The is the rest of the content
+```
+
+###### layouts/default.html.erb
+```erb
+<% yield %>
+
+<div class="sidebar">
+  <% yield :sidebar %>
+</div>
+```
+
+###### Result
+```
+The is the rest of the content 
+
+<div class="sidebar">
+  Sidebar
+</div>
+```
+
 ## Partials
 
 Partials are little pieces of template that can be easily reused. You can access the partials throught the `partial("partialpath")` method. You can optionall pass variables to the partial by passing a ruby hash of options as a second parameter. This works like this:
@@ -87,6 +125,38 @@ In the partial these can be accessed as local variables. So for instance in you
 <%= key %>
 ```
 
+### Blocks
+
+Just like `content_for` partials also accept block syntax. This way you can pass a block of HTML to the partial. It works like this:
+
+```erb
+<% partial "my-partial" do %>
+  Pass it to the partial
+<% end %>
+```
+
+Within your partial file you can then use the content by yielding it:
+
+```erb
+<div class="my-partial">
+    <% yield %>
+</div>
+```
+
+## Helpers
+Template helpers allow you to have custom functions in your templates. These functions will be executed in the same context as the template is in. This means they will have access to all other template features like the `document` and `env` variables.
+
+A helper is nothing more than a plain old Ruby module containing a bunch of functions.
+
+### Registering helpers
+Registering helpers can best be done in the Rogerfile. For every helper you want to register you need to call:
+
+```ruby
+Roger::Template.register MyHelperModule
+```
+
+After registration the helpers are available for use in all templates, partials, layouts, etc.
+
 ## Access to Project 
 
 You can access the Roger project with all it's might and glory by accessing `env["roger.project"]`.

data/lib/roger/cli/test.rb

@@ -7,7 +7,7 @@ module Roger
 
     default_task :all
 
-    desc "all", "Run all tests defined in Mockupfile. (this is the default action)"
+    desc "all", "Run all tests defined in Rogerfile. (this is the default action)"
     def all
       # If we use fail here the test breaks; no idea why
       # rubocop:disable Style/SignalException:

data/lib/roger/generators/generator.rb

@@ -13,7 +13,7 @@ class Roger::Generators::GeneratorGenerator < Roger::Generators::Base
   def create_lib_file
     destination = "#{path}/#{name}_generator.rb"
     template("templates/generator.tt", destination)
-    say "Add `require #{destination}` to your mockup file and run mockup generate #{name}."
+    say "Add `require #{destination}` to your Rogerfile and run roger generate #{name}."
   end
 end
 

data/lib/roger/generators/new.rb

@@ -1,12 +1,12 @@
 require "shellwords"
 
-# Generator to create a new HTML mockup based on an existing skeleton
+# Generator to create a new HTML project based on an existing skeleton
 class Roger::Generators::NewGenerator < Thor::Group
   include Thor::Actions
 
-  desc "Create a new HTML mockup based on an existing skeleton"
+  desc "Create a new HTML roger project based on an existing skeleton"
 
-  argument :path, type: :string, required: true, desc: "Path to generate mockup into"
+  argument :path, type: :string, required: true, desc: "Path to generate project into"
 
   class_option(
     :template,
@@ -29,7 +29,7 @@ class Roger::Generators::NewGenerator < Thor::Group
   def validate_path_is_empty
     return unless File.directory?(destination_root)
 
-    say "Directory #{destination_root} already exists, please only use this to create new mockups"
+    say "Directory #{destination_root} already exists, please only use this to create new projects"
     exit(1)
   end
 
@@ -48,7 +48,7 @@ class Roger::Generators::NewGenerator < Thor::Group
     puts e.backtrace.join("\n")
   end
 
-  def create_mockup
+  def create_project
     directory(".", ".")
   end
 
@@ -71,7 +71,7 @@ class Roger::Generators::NewGenerator < Thor::Group
 
   def temp_directory
     # Hack to create temp directory
-    t = Tempfile.new("htmlmockup-generate-new")
+    t = Tempfile.new("roger-generate-new")
     tmp_dir = Pathname.new(t.path)
     t.close
     t.unlink

data/lib/roger/project.rb

@@ -2,20 +2,20 @@ require File.dirname(__FILE__) + "/release"
 require File.dirname(__FILE__) + "/server"
 require File.dirname(__FILE__) + "/test"
 
-require File.dirname(__FILE__) + "/mockupfile"
+require File.dirname(__FILE__) + "/rogerfile"
 
 module Roger
-  # Loader for mockupfile and project dependencies
+  # Loader for rogerfile and project dependencies
   class Project
     # @attr :path [Pathname] The project path
-    # @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 :mockupfile_path [Pathname] The path to the Mockupfile
+    # @attr :html_path [Pathname] The path of the HTML of this project
+    # @attr :partial_path [Pathname] The path for the partials for this project
+    # @attr :rogerfile [Rogerfile] The Rogerfile for this project
+    # @attr :rogerfile_path [Pathname] The path to the Rogerfile
     # @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
+                  :rogerfile, :rogerfile_path, :mode
 
     attr_accessor :shell
 
@@ -28,7 +28,7 @@ module Roger
         html_path: @path + "html",
         partial_path: @path + "partials",
         layouts_path: @path + "layouts",
-        mockupfile_path: @path + "Mockupfile",
+        rogerfile_path: @path + "Rogerfile",
         server: {},
         release: {},
         test: {}
@@ -38,7 +38,8 @@ module Roger
       options.each { |k, v| @options[k.is_a?(String) ? k.to_sym : k] = v }
 
       initialize_accessors
-      initialize_mockup
+      intialize_rogerfile_path
+      initialize_roger
     end
 
     def shell
@@ -76,21 +77,40 @@ module Roger
 
     protected
 
+    def intialize_rogerfile_path
+      # We stop immediately if rogerfile is not a Pathname
+      unless @options[:rogerfile_path].is_a? Pathname
+        self.rogerfile_path = @options[:rogerfile_path]
+        return
+      end
+
+      # If roger file exist we're good to go
+      if @options[:rogerfile_path].exist?
+        self.rogerfile_path = @options[:rogerfile_path]
+      else
+        # If the rogerfile does not exist we check for deprecated Mockupfile
+        mockupfile_path = path + "Mockupfile"
+        if mockupfile_path.exist?
+          warn("Mockupfile has been deprecated! Please rename Mockupfile to Rogerfile")
+          self.rogerfile_path = mockupfile_path
+        end
+      end
+    end
+
     def initialize_accessors
       self.html_path = @options[:html_path]
       self.partial_path =
         @options[:partials_path] || @options[:partial_path] || html_path + "../partials/"
       self.layouts_path = @options[:layouts_path]
-      self.mockupfile_path = @options[:mockupfile_path]
       self.shell = @options[:shell]
     end
 
-    def initialize_mockup
-      if mockupfile_path
-        @mockupfile = Mockupfile.new(self, mockupfile_path)
-        @mockupfile.load
+    def initialize_roger
+      if rogerfile_path
+        @rogerfile = Rogerfile.new(self, rogerfile_path)
+        @rogerfile.load
       else
-        @mockupfile = Mockupfile.new(self)
+        @rogerfile = Rogerfile.new(self)
       end
     end
 

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

@@ -22,7 +22,7 @@ module Roger::Release::Finalizers
 
     def call(release, options = {})
       @options = @options.dup.update(options)
-      remote = find_git_remote
+      remote = find_git_remote(release.project.path)
       branch = @options[:branch]
 
       tmp_dir = Pathname.new(::Dir.mktmpdir)
@@ -126,10 +126,10 @@ module Roger::Release::Finalizers
       path
     end
 
-    def find_git_remote
+    def find_git_remote(path)
       remote =
         @options[:remote] ||
-        `git --git-dir=#{find_git_dir} config --get remote.origin.url`
+        `git --git-dir=#{Shellwords.escape(find_git_dir(path).to_s)} config --get remote.origin.url`
 
       remote.strip!
 

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

@@ -2,7 +2,7 @@ require "shellwords"
 require "English"
 
 module Roger::Release::Finalizers
-  # Finalizes the release by uploading your mockup with rsync to a remote server
+  # Finalizes the release by uploading your project with rsync to a remote server
   #
   # @see RsyncFinalizer#initialize for options
   #

data/lib/roger/release/processors/mockup.rb

@@ -52,7 +52,7 @@ module Roger::Release::Processors
       end
     end
 
-    # Runs the extractor on a single file and return processed source.
+    # Runs the template on a single file and return processed source.
     def extract_source_from_file(file_path, env = {})
       Roger::Template.open(
         file_path,

data/lib/roger/release/processors/url_relativizer.rb

@@ -1,3 +1,4 @@
+require "hpricot"
 require File.dirname(__FILE__) + "../../../resolver"
 
 module Roger::Release::Processors

data/lib/roger/release.rb

@@ -72,9 +72,9 @@ module Roger
     end
 
     # Accessor for source_path
-    # The source path is the root of the mockup
+    # The source path is the root of the project
     #
-    # @return Pathanem the source_path
+    # @return Pathname the source_path
     def source_path
       Pathname.new(config[:source_path])
     end
@@ -166,18 +166,6 @@ module Roger
       end
     end
 
-    # Extract the mockup, this will happen anyway, and will always happen first
-    # This method gives you a way to pass options to the extractor.
-    #
-    # @param Hash options Options hash passed to extractor
-    #
-    # @deprecated Don't use the extractor anymore, use release.use(:mockup, options) processor
-    def extract(options = {})
-      warn(self, "Don't use the extractor anymore, use release.use(:mockup, options)
-        and release.use(:url_relativizer, options) processors")
-      @extractor_options = options
-    end
-
     # Actually perform the release
     def run!
       project.mode = :release
@@ -202,6 +190,33 @@ module Roger
       project.mode = nil
     end
 
+    # @param [String] string The string to comment
+    #
+    # @option options [:html, :css, :js] :style The comment style to use
+    #   (default=:js, which is the same as :css)
+    # @option options [Boolean] :per_line Comment per line or make one block? (default=true)
+    def comment(string, options = {})
+      options = {
+        style: :css,
+        per_line: true
+      }.update(options)
+
+      commenters = {
+        html: proc { |s| "<!-- #{s} -->" },
+        css: proc { |s| "/* #{s} */" },
+        js: proc { |s| "/* #{s} */" }
+      }
+
+      commenter = commenters[options[:style]] || commenters[:js]
+
+      if options[:per_line]
+        string = string.split(/\r?\n/)
+        string.map { |s| commenter.call(s) }.join("\n")
+      else
+        commenter.call(string)
+      end
+    end
+
     protected
 
     def get_files_default_path
@@ -243,8 +258,7 @@ module Roger
       end
     end
 
-    # Checks if deprecated extractor options have been set
-    # Checks if the mockup will be runned
+    # Checks if the project will be runned
     # If config[:blank] is true it will automatically add UrlRelativizer or Mockup processor
     def validate_stack!
       return if config[:blank]
@@ -252,11 +266,6 @@ module Roger
       mockup_options = {}
       relativizer_options = {}
 
-      if @extractor_options
-        mockup_options = { env: @extractor_options[:env] }
-        relativizer_options = { url_attributes: @extractor_options[:url_attributes] }
-      end
-
       unless find_in_stack(Roger::Release::Processors::Mockup)
         @stack.unshift([Roger::Release::Processors::Mockup.new, mockup_options])
       end
@@ -273,10 +282,11 @@ module Roger
     end
 
     def copy_source_path_to_build_path!
+      mkdir(build_path)
+
       if config[:cp]
         copy_source_path_to_build_path_using_system
       else
-        mkdir(build_path)
         cp_r(source_path.children, build_path)
       end
     end
@@ -316,37 +326,9 @@ module Roger
       log(self, "Cleaning up build path #{build_path}")
       rm_rf(build_path)
     end
-
-    # @param [String] string The string to comment
-    #
-    # @option options [:html, :css, :js] :style The comment style to use
-    #   (default=:js, which is the same as :css)
-    # @option options [Boolean] :per_line Comment per line or make one block? (default=true)
-    def comment(string, options = {})
-      options = {
-        style: :css,
-        per_line: true
-      }.update(options)
-
-      commenters = {
-        html: proc { |s| "<!-- #{s} -->" },
-        css: proc { |s| "/*! #{s} */" },
-        js: proc { |s| "/*! #{s} */" }
-      }
-
-      commenter = commenters[options[:style]] || commenters[:js]
-
-      if options[:per_line]
-        string = string.split(/\r?\n/)
-        string.map { |s| commenter.call(s) }.join("\n")
-      else
-        commenter.call(s)
-      end
-    end
   end
 end
 
-require File.dirname(__FILE__) + "/extractor"
 require File.dirname(__FILE__) + "/release/scm"
 require File.dirname(__FILE__) + "/release/injector"
 require File.dirname(__FILE__) + "/release/cleaner"

data/lib/roger/{mockupfile.rb → rogerfile.rb}

@@ -1,15 +1,22 @@
 module Roger
-  # Loader for mockupfile
-  class Mockupfile
-    # This is the context for the mockupfile evaluation. It should be empty except for the
-    # #mockup method.
+  # Loader for rogerfile
+  class Rogerfile
+    # This is the context for the rogerfile evaluation. It should be empty except for the
+    # #roger method (and deprecated #mockup method).
     class Context
-      def initialize(mockupfile)
-        @_mockupfile = mockupfile
+      def initialize(rogerfile)
+        @_rogerfile = rogerfile
       end
 
+      def roger
+        @_rogerfile
+      end
+
+      # @deprecated Please use roger method instead.
       def mockup
-        @_mockupfile
+        warn("The use of mockup has been deprecated; please use roger instead")
+        warn("  on #{caller.first}")
+        roger
       end
 
       def binding
@@ -17,15 +24,15 @@ module Roger
       end
     end
 
-    # @attr :path [Pathname] The path of the Mockupfile for this project
+    # @attr :path [Pathname] The path of the rogerfile for this project
     attr_accessor :path, :project
 
     def initialize(project, path = nil)
       @project = project
-      @path = (path && Pathname.new(path)) || Pathname.new(project.path + "Mockupfile")
+      @path = (path && Pathname.new(path)) || Pathname.new(project.path + "Rogerfile")
     end
 
-    # Actually load the mockupfile
+    # Actually load the rogerfile
     def load
       return unless File.exist?(@path) && !self.loaded?
 
@@ -35,7 +42,7 @@ module Roger
       @loaded = true
     end
 
-    # Wether or not the Mockupfile has been loaded
+    # Wether or not the rogerfile has been loaded
     def loaded?
       @loaded
     end