rails_pages 0.0.1 → 0.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 63b1452839cdb15777d8d767e8dff58ede69bb3b
-  data.tar.gz: 9b8268c0c7a3942236422bd5f5951471318b7efd
+  metadata.gz: 136a1fe8daa9d56878c52c4f163c8c239175c653
+  data.tar.gz: f0d9c08d08a5704974e8213784a980eef575c13d
 SHA512:
-  metadata.gz: c047961b47f989f7ef39f3bf7c4d72f1e0cfb830efa28963cd8770da2256bac745591b0d1a5980d555ddf6fcae4a88826c2edb2af2709084a8f0ef36a46b31c5
-  data.tar.gz: 146c960f8bcf3543ed2c5df17fcd176f0dd2f6edf3a507bc79a258af7eb3a6c67a8bccb4a75751f531c101355c37e4bef21b86e4b083db7706c8e66376c998fe
+  metadata.gz: 16a7c767c5ca38bb4ca51acaad755e55329f0463a4e68767ddb43065558a393be2b60b88662ae93c5a51240e3def2e21f20ee4ced64dccfc70f52aefa8a98829
+  data.tar.gz: 56ece8c3455c6a572f7b24becc90d3b071f89170c1fe084c1bc844b2114f9a5f6fa215b05ccf09d5cf8e81d49247c40ab1877aba1ed50cb48fa45e6e4524b965

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    rails_pages (0.0.1)
+    rails_pages (0.0.2)
       rails (~> 4.0.0)
 
 GEM

data/README.md

@@ -2,6 +2,141 @@
 
 Static pages on Rails.
 
+## Installation
+
+```
+$ gem install rails_pages
+```
+
+```ruby
+# Gemfile
+gem 'rails_pages'
+```
+
+## Usage
+
+Note that nested page directory structures are accepted by default.
+
+Create static pages:
+
+```
+$ mkdir app/views/rails_pages
+$ touch app/views/rails_pages/page.html.erb
+```
+
+Visit pages `http://0.0.0.0:3000/pages/page`.
+
+### Generating resources
+
+```
+$ rails generate rails_pages:scaffold products
+```
+
+Would generate the following:
+
+```ruby
+# app/controllers/products_controller.rb
+class ProductsController < RailsPages::PagesController
+end
+```
+
+```ruby
+# spec/controllers/products_controller_spec.rb
+require 'spec_helper'
+
+describe ProductsController do
+end
+```
+
+```ruby
+# config/routes.rb
+resources :products,
+  :only        => :show,
+  :format      => false,
+  :constraints => { :id => /.+?/ }
+```
+
+Create static pages:
+
+```
+$ mkdir app/views/products
+$ touch app/views/products/product.html.erb
+```
+
+Visit pages `http://0.0.0.0:3000/products/product`.
+
+## Routing
+
+Link to pages with [named helpers][named-helpers]:
+
+[named-helpers]: http://guides.rubyonrails.org/routing.html#overriding-the-named-helpers
+
+```erb
+<%= link_to 'Page', page_path('page') %>
+```
+
+Define root path:
+
+```ruby
+# config/routes.rb
+root 'pages#show', :id => 'home'
+```
+
+Define root-level resource routes:
+
+```ruby
+# config/routes.rb
+get '/:id' => 'pages#show',
+  :as          => :page,
+  :format      => false,
+  :constraints => { :id => /.+?/ }
+```
+
+Exclude specific pages from resource routes:
+
+```ruby
+:constraints => { :id => /.+?(?<!home|new|edit)/ }
+```
+
+Disable default routes:
+
+```ruby
+# config/initializers/rails_pages.rb
+RailsPages.configure do |config|
+  config.default_routes = false
+end
+```
+
+## Testing
+
+[Rspec controller][rspec-controller] example:
+
+[rspec-controller]: https://github.com/rspec/rspec-rails#controller-specs
+
+```ruby
+# spec/controllers/products_controller_spec.rb
+require 'spec_helper'
+
+describe ProductsController do
+  describe 'GET /products/product' do
+    before { get :show, :id => 'product' }
+
+    it 'responds successfully with an HTTP 200 status code' do
+      expect(response).to be_success
+      expect(response.status).to eq(200)
+    end
+
+    it 'renders requested template' do
+      expect(response).to render_template('product')
+    end
+
+    it 'inherits layout from ApplicationController' do
+      expect(response).to render_template('layouts/application')
+    end
+  end
+end
+```
+
 ## License
 
 This is free and unencumbered software released into the public domain.

data/config/routes.rb

@@ -1,7 +1,9 @@
 Rails.application.routes.draw do
-  resources :pages,
-    :module      => :rails_pages,
-    :only        => :show,
-    :format      => false,
-    :constraints => { :id => /.+?/ }
+  if RailsPages.configuration.default_routes
+    resources :pages,
+      :module      => :rails_pages,
+      :only        => :show,
+      :format      => false,
+      :constraints => { :id => /.+?/ }
+  end
 end

data/lib/rails_pages/configuration.rb

@@ -0,0 +1,21 @@
+module RailsPages
+  class Configuration
+    attr_accessor :default_routes
+
+    def initialize
+      @default_routes = true
+    end
+  end
+
+  class << self
+    attr_accessor :configuration
+  end
+
+  def self.configuration
+    @configuration ||=  Configuration.new
+  end
+
+  def self.configure
+    yield configuration if block_given?
+  end
+end

data/lib/rails_pages/version.rb

@@ -1,3 +1,3 @@
 module RailsPages
-  VERSION = '0.0.1'
+  VERSION = '0.0.2'
 end

data/lib/rails_pages.rb

@@ -1 +1,2 @@
+require 'rails_pages/configuration'
 require 'rails_pages/engine' if defined?(Rails)

data/spec/rails_pages/configuration_spec.rb

@@ -0,0 +1,21 @@
+require 'spec_helper'
+
+describe RailsPages::Configuration do
+  describe 'default_routes' do
+    context 'enabled' do
+      it 'returns true' do
+        expect(RailsPages.configuration.default_routes).to be_true
+      end
+    end
+
+    context 'disabled' do
+      before do
+        RailsPages.configure { |c| c.default_routes = false }
+      end
+
+      it 'returns false' do
+        expect(RailsPages.configuration.default_routes).to be_false
+      end
+    end
+  end
+end

data/spec/routing/routes_spec.rb

@@ -73,4 +73,22 @@ describe 'routing' do
       Rails.application.reload_routes!
     end
   end
+
+  context 'disabled' do
+    before do
+      RailsPages.configure { |c| c.default_routes = false }
+    end
+
+    describe 'pages' do
+      it "does not route '/:id'" do
+        expect(:get => '/page').not_to be_routable
+      end
+    end
+
+    describe 'nested pages' do
+      it "does not route '/nested/:id'" do
+        expect(:get => '/nested/page').not_to be_routable
+      end
+    end
+  end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rails_pages
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
 platform: ruby
 authors:
 - Niclas Gelin
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-10-06 00:00:00.000000000 Z
+date: 2013-10-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -88,6 +88,7 @@ files:
 - lib/generators/rails_pages/scaffold/USAGE
 - lib/generators/rails_pages/scaffold/scaffold_generator.rb
 - lib/rails_pages.rb
+- lib/rails_pages/configuration.rb
 - lib/rails_pages/engine.rb
 - lib/rails_pages/version.rb
 - rails_pages.gemspec
@@ -115,6 +116,7 @@ files:
 - spec/integration/controller_generator_spec.rb
 - spec/integration/resource_route_generator_spec.rb
 - spec/integration/scaffold_generator_spec.rb
+- spec/rails_pages/configuration_spec.rb
 - spec/routing/routes_spec.rb
 - spec/spec_helper.rb
 homepage: https://github.com/niclasgelin/rails_pages
@@ -166,5 +168,6 @@ test_files:
 - spec/integration/controller_generator_spec.rb
 - spec/integration/resource_route_generator_spec.rb
 - spec/integration/scaffold_generator_spec.rb
+- spec/rails_pages/configuration_spec.rb
 - spec/routing/routes_spec.rb
 - spec/spec_helper.rb