roger 1.1.3 → 1.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 529078b0dd6c7db86bf462cc8c41227781a2ffd6
-  data.tar.gz: 5a9ea1e08b310b790b0db1d98eab685050d96b77
+  metadata.gz: d86fb892f4028385d30405b3f4d06fa709cf4d5e
+  data.tar.gz: c0bf2f37b72b13a4b9e070487915d4915717eea1
 SHA512:
-  metadata.gz: 136bbf5bda373b17f22552debc7ab00a86dc14e4f58eb4c10d031fee800e9eee21802620482c848c9f8a02cc39b2a64e1a30bd14143e890898b363d9e82042bf
-  data.tar.gz: 223c5f6a9e329d6e6a9f4913a5925c587f51106bb261f31190c00df03483e77a57fdcca37c3c1529819e7e094f8d0ef7dcc00000ca80d6eb647da5225804ad8b
+  metadata.gz: c4f2e4e2948a90dfb8ace4ef4763b85cd4309fb03e144fde95199d04dc0746e9fc38a4af80fb7617ff5f1cee1250fc6209cd1470d7a0369a3959b694af467c27
+  data.tar.gz: 2a4ae577eb0a87c5d8835737ba6974e5c72f057b90d890b3cc6ba75557c546a3652ff94d149ec56be1ff85e95ebf71304066965f6cf4c9944e25f6f80e93fa07

data/.hound.yml

@@ -0,0 +1,2 @@
+ruby:
+  config_file: .rubocop.yml

data/.rubocop.yml

@@ -0,0 +1,47 @@
+LineLength:
+  Description: 'Limit lines to 100 characters.'
+  Max: 100
+  Enabled: true
+
+StringLiterals:
+  EnforcedStyle: double_quotes
+  Enabled: true
+
+Style/DotPosition:
+  EnforcedStyle: trailing
+  Enabled: true
+
+Metrics/MethodLength:
+  CountComments: false  # count full line comments?
+  Max: 20
+
+Metrics/AbcSize:
+  Max: 20
+
+Style/ClassAndModuleChildren:
+  EnforcedStyle: compact
+  Enabled: false
+
+# By default, the rails cops are not run. Override in project or home
+# directory .rubocop.yml files, or by giving the -R/--rails option.
+AllCops:
+  RunRailsCops: false
+
+# Disabled cops
+Metrics/ClassLength:
+  Enabled: false
+
+Metrics/ModuleLength:
+  Enabled: false
+
+Style/EachWithObject:
+  Enabled: false
+
+Style/AccessorMethodName:
+  Enabled: false
+
+Lint/AssignmentInCondition:
+  Enabled: false
+
+Style/SingleLineBlockParams:
+  Enabled: false

data/.travis.yml

@@ -3,13 +3,9 @@ rvm:
   - 1.9.3
   - 2.0.0
   - 2.1.1
-  - rbx-2
-  - jruby
+  - 2.2.2
 before_script:
   - git config --global user.email "travis-ci@digitpaint.nl"
   - git config --global user.name "Travis-CI"
 matrix:
-  allow_failures:
-    - rvm: rbx-2
-    - rvm: jruby
   fast_finish: true

data/CHANGELOG.md

@@ -1,5 +1,13 @@
 # Changelog
 
+## Version 1.2.1
+* Fix missing env (https://github.com/DigitPaint/roger/issues/24) 
+
+## Version 1.2.0
+* `roger.project` is now always in `env` when running as a project or as a release. Use this in favor of `env["MOCKUP_PROJECT"]`
+* All Roger code now is linted by Rubocop. More tests have been added and more documentation as well. Still not everything may have been covered by the tests. 
+
+
 ## Version 1.1.3
 * Add `--version` flag so we can ask what version of Roger we're running.
 

data/Gemfile

@@ -1,5 +1,5 @@
-source 'https://rubygems.org'
+source "https://rubygems.org"
 
-gemspec :name => "roger"
+gemspec name: "roger"
 
-gem "rake"
+gem "rake"

data/Rakefile

@@ -1,9 +1,15 @@
-require 'rake/testtask'
+require "rake/testtask"
+require "rubocop/rake_task"
 
-task :default => [:test]
+task default: [:test, :rubocop]
+
+desc "Run rubocop"
+task :rubocop do
+  RuboCop::RakeTask.new
+end
 
 Rake::TestTask.new do |t|
   t.libs << "test"
-  t.test_files = FileList['test/unit/**/*_test.rb']
+  t.test_files = FileList["test/unit/**/*_test.rb"]
   t.verbose = true
-end
+end

data/bin/roger

@@ -2,4 +2,4 @@
 
 require File.dirname(__FILE__) + "/../lib/roger/cli"
 
-Roger::Cli::Base.start
+Roger::Cli::Base.start

data/doc/mockupfile.md

@@ -1,3 +1,100 @@
 # Mockupfile
 
 The mockupfile is where all the project configuration for releasing, serving etc. happens.
+
+## Example
+
+```ruby
+
+# Some SASS defaults
+Sass::Plugin.options[:style] = :expanded
+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
+
+# These are defaults, but can be set here
+# mockup.project.html_path = mockup.project.path + "html"
+# mockup.project.partial_path = mockup.project.path + "partials"
+
+# Server is a regular Rack interface.
+mockup.serve do |server|
+  server.use :sass
+end
+
+# Define tests
+mockup.test do |t|
+  t.use :jshint
+end
+
+mockup.release do |release|
+  
+  # The variables below can be used anywhere in this section
+  release.target_path # The target path where releases are put
+  release.build_path # The path where the release gets built
+  release.source_path # The source for this mockup
+
+  # Get git version, these variables can be used anywhere in this section
+  release.scm.previous # Get the previous version SCM op (looks for tags)
+  release.scm.version # Get the git version
+  release.scm.date # Get the git date
+
+  # Extract mockup (this is optional)
+  # release.mockup
+
+  # Create custom banner
+  #
+  # The default banner looks like this:
+  #
+  # =======================
+  # = Version : v1.0.0    =
+  # = Date : 2012-06-20   =
+  # =======================
+  release.banner do
+    "bla bla bla"
+  end
+
+  # Sassify CSS (this are the defaults too), all options except form :match and :skip are passed to Sass.compile_file
+  # release.use :sass, :match => ["stylesheets/**/*.scss"], :skip => [/_.*\.scss\Z/], :style => :expanded
+  # The previous statement is the same as:
+  release.use :sass
+
+  # Run requirejs optimizer
+  # release.use :requirejs, {
+  #     :build_files => {"javascripts/site.build.js" => "javascripts"},
+  #     :rjs => release.source_path + "../vendor/requirejs/r.js",
+  #     :node => "node"
+  #   }
+  release.use :requirejs
+
+  # Minify, will not minify anything above the :delimiter
+  # release.use :yuicompressor, {
+  #   :match => ["**/*.{css,js}"],
+  #   :skip =>  [/javascripts\/vendor\/.*\.js\Z/, /_doc\/.*/],
+  #   :delimiter => Regexp.escape("/* -------------------------------------------------------------------------------- */")
+  # }
+  # The previous statement is the same as:
+  release.use :yuicompressor
+
+  # Inject VERSION / DATE (i.e. in TOC)
+  r.inject({ "[VERSION]" => release.scm.version, "[DATE]" => release.scm.date.strftime("%Y-%m-%d") }, into: %w(_doc/toc.html))
+
+  # Inject Banners on everything matching the regexp in all .css files
+  # The banner will be commented as CSS.
+  release.inject({ /\/\*\s*\[BANNER\]\s*\*\// => r.banner(comment: :css) }, into: %w(**/*.css))
+
+  # Inject CHANGELOG
+  release.inject({ "[CHANGELOG]" => { file: "../CHANGELOG", processor: "md" } }, into: %w(_doc/changelog.html))
+
+  # Inject NOTES
+  release.inject({ "[NOTES]" => { file: "../NOTES.md", processor: "md" } }, into: %w(_doc/notes.html))
+
+  # Cleanup on the build
+  release.cleanup "**/.DS_Store"
+
+  # Finalize the release
+  # This is the default finalizer so not required
+  # release.finalize :dir
+end
+```

data/doc/templating.md

@@ -85,4 +85,8 @@ In the partial these can be accessed as local variables. So for instance in you
 
 ```erb
 <%= key %>
-```
+```
+
+## Access to Project 
+
+You can access the Roger project with all it's might and glory by accessing `env["roger.project"]`.

data/examples/default_template/Gemfile

@@ -1,3 +1,3 @@
 source :rubygems
 
-gem "roger"
+gem "roger"

data/lib/roger/cli.rb

@@ -1,24 +1,21 @@
-require 'rubygems'
+require "rubygems"
 
 # Require bundler gems if available
-if Object.const_defined?(:Bundler)
-  Bundler.require(:default)
-end
-
+Bundler.require(:default) if Object.const_defined?(:Bundler)
 
-require 'thor'
-require 'thor/group'
+require "thor"
+require "thor/group"
 
-require 'pathname'
-require 'fileutils'
+require "pathname"
+require "fileutils"
 include FileUtils
 
 require File.dirname(__FILE__) + "/version"
 require File.dirname(__FILE__) + "/template"
 require File.dirname(__FILE__) + "/project"
 
-
 module Roger
+  # The CLI namespace
   module Cli; end
 end
 
@@ -31,10 +28,9 @@ require File.dirname(__FILE__) + "/cli/test"
 require File.dirname(__FILE__) + "/generators"
 require File.dirname(__FILE__) + "/test"
 
-
 module Roger
+  # The Roger main entrypoint!
   class Cli::Base < Thor
-
     def initialize(*args)
       super
       self.class.project ||= initialize_project
@@ -49,38 +45,49 @@ module Roger
     end
 
     class_option :path,
-      :desc => "Project root path",
-      :type => :string,
-      :required => false,
-      :default => "."
+                 desc: "Project root path",
+                 type: :string,
+                 required: false,
+                 default: "."
 
     class_option :html_path,
-      :desc => 'The document root, defaults to "[directory]/html"',
-      :type => :string
+                 desc: 'The document root, defaults to "[directory]/html"',
+                 type: :string
 
     class_option :partial_path,
-      :desc => 'Defaults to [directory]/partials',
-      :type => :string
+                 desc: "Defaults to [directory]/partials",
+                 type: :string
 
     class_option :verbose,
-      :desc =>  "Sets verbose output",
-      :aliases => ["-v"],
-      :default => false,
-      :type => :boolean
+                 desc: "Sets verbose output",
+                 aliases: ["-v"],
+                 default: false,
+                 type: :boolean
 
-    map %w{--version} => :version
+    map %w(--version) => :version
 
-    desc "test [COMMAND]", "Run one or more tests. Test can be 'all' for all defined tests or a specific test name"
+    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
-
-    register Cli::Release, "release", "release #{Cli::Release.arguments.map{ |arg| arg.banner }.join(" ")}", Cli::Release.desc
-    self.tasks["release"].options = Cli::Release.class_options
+    register(
+      Cli::Serve,
+      "serve",
+      "serve #{Cli::Serve.arguments.map(&:banner).join(' ')}",
+      Cli::Serve.desc
+    )
+    tasks["serve"].options = Cli::Serve.class_options
+
+    register(
+      Cli::Release,
+      "release",
+      "release #{Cli::Release.arguments.map(&:banner).join(' ')}",
+      Cli::Release.desc
+    )
+    tasks["release"].options = Cli::Release.class_options
 
     desc "version", "Get the current Roger version"
     def version
@@ -91,14 +98,12 @@ module Roger
 
     # TODO: handle options
     def initialize_project
-      if((Pathname.new(options[:path]) + "../partials").exist?)
+      if (Pathname.new(options[:path]) + "../partials").exist?
         puts "[ERROR]: Don't use the \"html\" path, use the project base path instead"
         exit(1)
       end
 
-      Project.new(options[:path], {:shell => self.shell}.update(options))
+      Project.new(options[:path], { shell: shell }.update(options))
     end
-
   end
-
-end
+end

data/lib/roger/cli/command.rb

@@ -1,11 +1,10 @@
 module Roger
-
+  # Abstract base class for Roger commands
   class Cli::Command < Thor::Group
     def self.exit_on_failure?
       true
     end
 
-
     def initialize_project
       @project = Cli::Base.project
     end
@@ -17,5 +16,4 @@ module Roger
       puts "  Partials: \"#{project.partial_path}\""
     end
   end
-
-end
+end

data/lib/roger/cli/generate.rb

@@ -1,4 +1,5 @@
 module Roger::Cli
+  # The Generate command
   class Generate < Thor
     def self.exit_on_failure?
       true

data/lib/roger/cli/release.rb

@@ -1,10 +1,10 @@
 module Roger
+  # The release command
   class Cli::Release < Cli::Command
-
     desc "Release the current project"
 
     def release
       @project.release.run!
     end
   end
-end
+end

data/lib/roger/cli/serve.rb

@@ -1,25 +1,26 @@
 module Roger
+  # The serve command
   class Cli::Serve < Cli::Command
-
-
     desc "Serve the current project"
 
-    class_options :port => :string, # Defaults to 9000
-                  :host => :string, # Defaults to 0.0.0.0
-                  :handler => :string # The handler to use (defaults to mongrel)
+    class_options port: :string, # Defaults to 9000
+                  host: :string, # Defaults to 0.0.0.0
+                  handler: :string # The handler to use (defaults to mongrel)
 
     def serve
       server_options = {}
-      options.each{|k,v| server_options[k.to_sym] = v }
+      options.each { |k, v| server_options[k.to_sym] = v }
       server_options[:server] = {}
       [:port, :handler, :host].each do |k|
-        server_options[:server][k] = server_options.delete(k) if server_options.has_key?(k)
+        server_options[:server][k] = server_options.delete(k) if server_options.key?(k)
       end
 
-      server = @project.server
-      server.set_options(server_options[:server])
+      @project.server.set_options(server_options[:server])
+    end
 
-      puts "Running Roger with #{server.handler.inspect} on  #{server.host}:#{server.port}"
+    def show_banner
+      server  = @project.server
+      puts "Running Roger with #{server.handler.inspect} on #{server.host}:#{server.port}"
       puts project_banner(@project)
     end
 
@@ -29,4 +30,3 @@ module Roger
     end
   end
 end
-