codelation_pages 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 3745af9140e5596642e6f781076060d75357b6d8
+  data.tar.gz: eb89629bbdd5972394fb86a0d87171db6849e4d6
+SHA512:
+  metadata.gz: bfdd0ca3a1ee8cb0b05f390286eb6fdc4afd5381c92023585ac536a7f0ea0aa06f503bc3f9bce5d6408435f46eeeadf44ca5c3ac611f357922b34a29065ec8ee
+  data.tar.gz: 5967749774d25a4f0d77b855537b101e20de17f2d9f234a24ad2d58351540dbee770a82deca887d0a1ab79865655b07f875f0ed949f1aca6a83fe10fdaa07b56

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright 2016 Brian Pattison
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,65 @@
+# Codelation Pages
+
+A extension of Rails routes mapper for automatically registering static pages.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem "codelation_pages"
+```
+
+Install the Codelation Pages gem with Bundler:
+
+```bash
+bundle install
+```
+
+## Usage
+
+**Example:** Creating an "About Us" page.
+
+### Views
+
+All static pages are served by the `PagesController`, so the HTML/ERB files live in
+`app/views/pages`. The `PagesController` is a generated controller,
+so you won't find it as a file in the code. If you define the controller,
+it will be used instead of the generated controller.
+
+If I want my about page to live at `http://example.com/about-us`,
+I would create the view file: `app/views/pages/about_us.html.erb`.
+The link helper will be available as `about_us_path`.
+
+#### Subfolders
+
+You can also create pages within subfolders, so if wanted to create a
+"Features > Overview" page that lives at `http://example.com/features/overview`,
+I would create the view file: `app/views/pages/features/overview.html.erb`.
+The link helper will be available as `features_overview_path`.
+
+Files within subfolders will not be served by the `PagesController`. They will
+be served by a generated controller matching the name of the folder. In the case of our
+"Features > Overview" page, the controller would be the `FeaturesController`.
+
+### Routes
+
+Add `draw_static_pages` to `config/routes.rb`:
+
+```ruby
+RailsProject::Application.routes.draw do
+  draw_static_pages
+end
+```
+
+## IMPORTANT
+
+**You will need to restart your Rails server after adding new page files.***
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1,34 @@
+begin
+  require "bundler/setup"
+rescue LoadError
+  puts "You must `gem install bundler` and `bundle install` to run rake tasks"
+end
+
+require "rdoc/task"
+
+RDoc::Task.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = "rdoc"
+  rdoc.title    = "Codelation Assets"
+  rdoc.options << "--line-numbers"
+  rdoc.rdoc_files.include("README.rdoc")
+  rdoc.rdoc_files.include("lib/**/*.rb")
+end
+
+APP_RAKEFILE = File.expand_path("../test/dummy/Rakefile", __FILE__)
+load "rails/tasks/engine.rake"
+
+
+
+Bundler::GemHelper.install_tasks
+
+require "rake/testtask"
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << "lib"
+  t.libs << "test"
+  t.pattern = "test/**/*_test.rb"
+  t.verbose = false
+end
+
+
+task default: :test

data/lib/codelation_pages/version.rb

@@ -0,0 +1,3 @@
+module CodelationPages
+  VERSION = "0.0.1".freeze
+end

data/lib/codelation_pages.rb

@@ -0,0 +1,4 @@
+require "extensions/action_dispatch/routing/mapper"
+
+module CodelationPages
+end

data/lib/extensions/action_dispatch/routing/mapper.rb

@@ -0,0 +1,73 @@
+module ActionDispatch::Routing
+  # Hacking on ActionDispatch::Routing::Mapper provides additional methods for defining
+  # routes. These include being able to organize routes into multiple files and
+  # a whole lot of magic for generating routes and controllers for static pages.
+  class Mapper
+    # Method for organizing the routes file into multiple files
+    # @see http://blog.arkency.com/2015/02/how-to-split-routes-dot-rb-into-smaller-parts/
+    def draw(routes_name)
+      instance_eval(File.read(Rails.root.join("config/routes/#{routes_name}.rb")))
+    end
+
+    # Method for drawing the routes for static pages automatically.
+    # Any .html.erb file in `app/views/pages` will be served as the dasherized file name.
+    # @example
+    #   about_us.html.erb will be served at http:/example/about-us
+    #   and the link helper will be available as `about_us_path`
+    def draw_static_pages
+      draw_routes
+      generate_controller
+      draw_sub_pages
+    end
+
+  private
+
+    # Returns a controller for serving statis files. The view path is
+    # set so the view files can all be in the `pages` directory.
+    def controller(directory_name = "")
+      Class.new(ApplicationController) do
+        # Defines where the controller will look for the view files.
+        def self.controller_path
+          controller_path = name.gsub("Controller", "").underscore
+          controller_path == "pages" ? "pages" : File.join("pages", controller_path)
+        end
+      end
+    end
+
+    # Draws the routes for static pages within sub folders.
+    # Any .html.erb file in a folder within `app/views/pages` will be served as
+    # the dasherized folder name and file name.
+    # @example
+    #   about_us/team.html.erb will be served at http:/example/about-us/team
+    #   and the link helper will be available as `about_us_team_path`
+    def draw_sub_pages
+      files = Dir["#{Rails.root.join('app', 'views', 'pages')}/*"]
+      directories = files.select {|file| File.directory? file }
+      directories.each do |directory|
+        directory_name = File.basename(directory)
+        draw_routes(directory_name)
+        generate_controller(directory_name)
+      end
+    end
+
+    # Draw the route using the directory and file name.
+    # @param directory_name [String]
+    def draw_routes(directory_name = "")
+      page_files = Dir["#{Rails.root.join('app', 'views', 'pages', directory_name)}/*.html.erb"]
+      page_files.each do |file_name|
+        page = File.basename(file_name, ".html.erb")
+        controller_name = directory_name.blank? ? "pages" : directory_name.underscore
+        path_name = directory_name.blank? ? page : "#{directory_name.underscore}_#{page}"
+        get "#{directory_name}/#{page}".dasherize, to: "#{controller_name}##{page}", as: path_name
+      end
+    end
+
+    # Generate a controller using the directory and file name if it doesn't exist.
+    # @param directory_name [String]
+    def generate_controller(directory_name = "pages")
+      controller_class_name = "#{directory_name.camelize}Controller"
+      controller_exists = Object.const_defined?(controller_class_name)
+      Object.const_set(controller_class_name, controller(directory_name)) unless controller_exists
+    end
+  end
+end

metadata

@@ -0,0 +1,79 @@
+--- !ruby/object:Gem::Specification
+name: codelation_pages
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Brian Pattison
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2016-01-18 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Codelation Pages automatically registers static pages in `app/views/pages`
+  with dasherized routes and automatically generated controllers for pages in subfolders.
+email:
+- brian@brianpattison.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE
+- README.md
+- Rakefile
+- lib/codelation_pages.rb
+- lib/codelation_pages/version.rb
+- lib/extensions/action_dispatch/routing/mapper.rb
+homepage: https://github.com/codelation/codelation_pages
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.5.1
+signing_key: 
+specification_version: 4
+summary: A extension of Rails routes mapper for automatically registering static pages.
+test_files: []