codelation_pages 0.0.1 → 0.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 3745af9140e5596642e6f781076060d75357b6d8
-  data.tar.gz: eb89629bbdd5972394fb86a0d87171db6849e4d6
+  metadata.gz: dadaf83a31dbb1dd37151f3772267d31dabc3e3d
+  data.tar.gz: 8c79d9b25c9c668dbcaeea7acd614cfcefd2e330
 SHA512:
-  metadata.gz: bfdd0ca3a1ee8cb0b05f390286eb6fdc4afd5381c92023585ac536a7f0ea0aa06f503bc3f9bce5d6408435f46eeeadf44ca5c3ac611f357922b34a29065ec8ee
-  data.tar.gz: 5967749774d25a4f0d77b855537b101e20de17f2d9f234a24ad2d58351540dbee770a82deca887d0a1ab79865655b07f875f0ed949f1aca6a83fe10fdaa07b56
+  metadata.gz: 53449bac2a18119f1073aef8ecf2a9660d0e6b2245911341e566df2c3cca6afa9044d6b97ecd5f414c5169149272729d87c78d43c8c6cd26e57285254f10690b
+  data.tar.gz: 0c879d254920a6facd6e97ad1770f8869406cf8f648d4f4093499070ea7eb4383978b94c6eed533a4c02dc9f2eb8406535d8daa0d0872c606f719cfdd98d8dc4

data/README.md

@@ -40,7 +40,7 @@ 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`.
+"Features > Overview" page, the controller would be the `Pages::FeaturesController`.
 
 ### Routes
 

data/lib/codelation_pages/version.rb

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

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

@@ -1,73 +1,102 @@
-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
+module ActionDispatch
+  module 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
+      # 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
+    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)
+      # Returns an application controller for serving static files.
+      def controller
+        Class.new(ApplicationController) do
         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)
+      # Returns whether or not a custom controller file exists.
+      # @param directory_name [String]
+      def custom_controller_exists(directory_name)
+        File.exist?(Rails.root.join("app", "controllers", "pages", "#{directory_name}_controller.rb"))
       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
+      # 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" : "pages/#{directory_name}"
+          path_name = directory_name.blank? ? page : "#{directory_name}_#{page}"
+          path = page == "index" ? directory_name.dasherize : "#{directory_name}/#{page}".dasherize
+          get path, to: "#{controller_name}##{page}", as: path_name
+        end
       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
+      # Generate a controller using the directory and file name if it doesn't exist.
+      # @param directory_name [String]
+      def generate_controller(directory_name = "pages")
+        if directory_name == "pages"
+          generate_pages_controller
+        else
+          generate_custom_controller(directory_name)
+        end
+      end
+
+      # Generates a controller based off the directory name if it
+      # doesn't exist in the `Pages` module.
+      # @param directory_name [String]
+      def generate_custom_controller(directory_name)
+        Object.const_set("Pages", Module.new) unless pages_module_exists
+        controller_class_name = "#{directory_name.camelize}Controller"
+        Pages.const_set(controller_class_name, controller) unless custom_controller_exists(directory_name)
+      end
+
+      # Generates the `PagesController` if it doesn't already exist
+      def generate_pages_controller
+        Object.const_set("PagesController", controller) unless pages_controller_exists
+      end
+
+      # Returns whether or not the PagesController file exists.
+      def pages_controller_exists
+        File.exist?(Rails.root.join("app", "controllers", "pages_controller.rb"))
+      end
+
+      # Returns whether or not the pages module directory exists
+      def pages_module_exists
+        File.exist?(Rails.root.join("app", "controllers", "pages"))
+      end
     end
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: codelation_pages
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
 platform: ruby
 authors:
 - Brian Pattison