carpentry 1.0.1 → 2.0.0

data/Gemfile

@@ -1,8 +1,14 @@
-source :rubygems
+source "https://rubygems.org"
 
-gem "rails", "3.0.7"
-gem "rake", "~> 0.9.2"
-gem "capybara", ">= 0.4.0"
+# Declare your gem's dependencies in carpentry.gemspec.
+# Bundler will treat runtime dependencies like base dependencies, and
+# development dependencies will be added by default to the :development group.
+gemspec
 
-gem "autotest-standalone"
-gem "rspec-rails"
+# Declare any dependencies that are still in development here instead of in
+# your gemspec. These might include edge Rails or gems from your path or
+# Git. Remember to move these dependencies to your gemspec before releasing
+# your gem to rubygems.org.
+
+# To use debugger
+# gem 'debugger'

data/README.md

@@ -1,15 +1,7 @@
 Carpentry
 =========
 
-     ____________________________________ 
-    / Carpentry – handcrafted prototypes \
-    \ with ease                          /
-     ------------------------------------ 
-          \   ^__^
-           \  (oo)\_______
-              (__)\       )\/\
-                  ||----w |
-                  ||     ||
+Handcrafted prototypes with ease.
 
 
 Installation
@@ -19,7 +11,7 @@ Add Carpentry to Gemfile:
 
     gem "carpentry"
 
-Run the generator to create the prototypes folder:
+Run the generator to create the prototypes folder (and inject the Carpentry route):
 
     rails generate carpentry:install
 
@@ -27,8 +19,8 @@ Run the generator to create the prototypes folder:
 Usage
 -----
 
-Put your views in app/views/carpentry/prototypes and view them in 
-browser at /p/path_to_file.
+Put your views in `app/views/carpentry/prototypes` and view them in
+browser at `/p/path_to_file`.
 
 Examples:
 
@@ -40,32 +32,52 @@ Examples:
 
 All available Rails helpers work nicely. Pure prototyping bliss!
 
+If you want an special layout for your prototypes, stick the layout file
+to `app/views/layouts/carpentry/prototypes.html.[format]`.
+
+
+You can customize the prototype URI prefix (`/p`) by editing the engine mount in your `roures.rb` file, for example:
+
+```
+  mount Carpentry::Engine => "/prototype"
+```
 
 Hooks
 -----
 
-Carpentry let's you add a `#before_carpentry` method in 
-`ApplicationController`, that will be run before any prototype. You can 
-use it, for example, to provide authentication or prevent prototypes 
+Carpentry let's you add a `#before_carpentry` method in
+`ApplicationController`, that will be run before any prototype. You can
+use it, for example, to provide authentication or prevent prototypes
 from being rendered in production.
 
 
+Rails and Ruby compatiblity
+---------------------------
+
+Carpentry is compatible with **Rails 3.2** and **Rails 4.0**.
+
+Only **Ruby 1.9.3** and above are supported, check [Travis CI][travis] for build details.
+
+If you want to use Carpentry with Ruby 1.9.2 or below, use [Carpentry v1.0.1][v1].
+
 Gotchas
 -------
 
 When rendering a partial, you must specify the full path
-(e.g. `carpentry/prototypes/posts/form`) unless the partial is in 
+(e.g. `carpentry/prototypes/posts/form`) unless the partial is in
 `app/views/carpentry/prototypes/`.
 
 
 License
 -------
 
-MIT License. Copyright 2011 Kisko Labs.
+MIT License. Copyright 2011-2013 Kisko Labs.
 
 
 CI Build Status
 ---------------
 
-[![Build Status](http://travis-ci.org/kiskolabs/carpentry.png)](http://travis-ci.org/kiskolabs/carpentry)
+[![Build Status](https://travis-ci.org/kiskolabs/carpentry.png?branch=master)][travis]
 
+[travis]: https://travis-ci.org/kiskolabs/carpentry
+[v1]: https://github.com/kiskolabs/carpentry/tree/v1.0.1

data/Rakefile

@@ -1,18 +1,21 @@
 # encoding: UTF-8
-require 'rubygems'
 begin
   require 'bundler/setup'
 rescue LoadError
   puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
 end
 
-require 'rake'
-require 'rake/task'
-
-require 'rspec/core'
-require 'rspec/core/rake_task'
+require "rdoc/task"
+RDoc::Task.new do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'Carpentry'
+  rdoc.options << '--line-numbers'
+  rdoc.rdoc_files.include('README.md')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
 
+require "rspec/core/rake_task"
 RSpec::Core::RakeTask.new(:spec)
-Bundler::GemHelper.install_tasks
+task default: :spec
 
-task :default => :spec
+Bundler::GemHelper.install_tasks

data/app/controllers/carpentry/prototypes_controller.rb

@@ -1,7 +1,7 @@
 module Carpentry
   class PrototypesController < ApplicationController
     before_filter :before_carpentry,
-      :if => proc { respond_to?(:before_carpentry, true) }
+      if: proc { respond_to?(:before_carpentry, true) }
 
     def serve
       env["carpentry.prototype"] = true
@@ -10,9 +10,9 @@ module Carpentry
       if Rails.application.config.consider_all_requests_local
         raise
       else
-        render :file => "#{Rails.root}/public/404.html",
-               :status => 404,
-               :layout => false
+        render file: "#{Rails.root}/public/404.html",
+               status: 404,
+               layout: false
       end
     end
   end

data/config/routes.rb

@@ -1,6 +1,4 @@
-Rails.application.routes.draw do
-  namespace "p", :module => :carpentry do
-    root :to => "prototypes#serve", :file_path => "index"
-    match "/*file_path" => "prototypes#serve"
-  end
+Carpentry::Engine.routes.draw do
+  root to: "prototypes#serve", file_path: "index"
+  match "/*file_path" => "prototypes#serve", via: :get
 end

data/lib/carpentry.rb

@@ -1,7 +1,8 @@
-require "carpentry/no_robots_middleware"
+# require "carpentry/no_robots_middleware"
+require "carpentry/engine"
 
 module Carpentry
   class Engine < ::Rails::Engine
-    config.app_middleware.use NoRobotsMiddleware
+    # config.app_middleware.use NoRobotsMiddleware
   end
 end

data/lib/carpentry/engine.rb

@@ -0,0 +1,11 @@
+require File.expand_path("../no_robots_middleware", __FILE__)
+
+module Carpentry
+  class Engine < ::Rails::Engine
+    isolate_namespace Carpentry
+
+    initializer "carpentry.add_middleware" do |app|
+      app.middleware.use Carpentry::NoRobotsMiddleware
+    end
+  end
+end

data/lib/carpentry/version.rb

@@ -1,3 +1,3 @@
 module Carpentry
-  VERSION = "1.0.1"
+  VERSION = "2.0.0"
 end

data/lib/generators/carpentry/install/install_generator.rb

@@ -5,6 +5,10 @@ module Carpentry
         empty_directory "app/views/carpentry/prototypes"
         create_file "app/views/carpentry/prototypes/.gitkeep"
       end
+
+      def add_carpentry_routes
+        route 'mount Carpentry::Engine => "/p"'
+      end
     end
   end
 end

data/lib/tasks/carpentry_tasks.rake

@@ -0,0 +1,4 @@
+# desc "Explaining what the task does"
+# task :carpentry do
+#   # Task goes here
+# end

metadata

@@ -1,69 +1,165 @@
---- !ruby/object:Gem::Specification 
+--- !ruby/object:Gem::Specification
 name: carpentry
-version: !ruby/object:Gem::Version 
+version: !ruby/object:Gem::Version
+  version: 2.0.0
   prerelease: 
-  version: 1.0.1
 platform: ruby
-authors: 
+authors:
 - Joao Carlos
-- "Vesa V\xC3\xA4nsk\xC3\xA4"
+- Vesa Vänskä
 - Matias Korhonen
 - Antti Salonen
 autorequire: 
 bindir: bin
 cert_chain: []
-
-date: 2011-07-04 00:00:00 Z
-dependencies: []
-
+date: 2013-10-25 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: railties
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 3.2.6
+    - - <
+      - !ruby/object:Gem::Version
+        version: '5'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 3.2.6
+    - - <
+      - !ruby/object:Gem::Version
+        version: '5'
+- !ruby/object:Gem::Dependency
+  name: rdoc
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 4.0.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 4.0.0
+- !ruby/object:Gem::Dependency
+  name: capybara
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 0.4.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 0.4.0
+- !ruby/object:Gem::Dependency
+  name: autotest-standalone
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec-rails
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 description: Handcrafted prototypes for Rails.
-email: 
+email:
 - contact@kiskolabs.com
 executables: []
-
 extensions: []
-
 extra_rdoc_files: []
-
-files: 
+files:
 - app/controllers/carpentry/prototypes_controller.rb
+- lib/carpentry/engine.rb
 - lib/carpentry/no_robots_middleware.rb
 - lib/carpentry/version.rb
 - lib/carpentry.rb
 - lib/generators/carpentry/install/install_generator.rb
+- lib/tasks/carpentry_tasks.rake
 - config/routes.rb
 - Rakefile
 - Gemfile
 - README.md
 homepage: https://github.com/kiskolabs/carpentry
-licenses: []
-
+licenses:
+- MIT
 post_install_message: 
 rdoc_options: []
-
-require_paths: 
+require_paths:
 - lib
-required_ruby_version: !ruby/object:Gem::Requirement 
+required_ruby_version: !ruby/object:Gem::Requirement
   none: false
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      hash: -4311851174712421241
-      segments: 
-      - 0
-      version: "0"
-required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: 1.9.3
+required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      version: "0"
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: -507400125341853681
 requirements: []
-
 rubyforge_project: 
-rubygems_version: 1.8.3
+rubygems_version: 1.8.25
 signing_key: 
 specification_version: 3
 summary: Protyping engine for Rails.
 test_files: []
-