component_library 1.0.1 → 2.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: cd5fe5f7f3c6f41062912135171378483084d10e
-  data.tar.gz: 3583250c2c8052803fc4a449f54081613b9fe0b6
+  metadata.gz: f948028f3babe799c67e8dffd6789092339401db
+  data.tar.gz: e2aab31127f0e2de4a06633b5c50fe31755f29e7
 SHA512:
-  metadata.gz: 10a1320e93de726c50c01aebc8e832afb628939957d80ed28753b789f2fc8bd76faacc6079089e5263a7d7b32b3a58c7497696a595ceae7d9b89d9355fa18ed8
-  data.tar.gz: 5f2aacc65111c63f6321a7274b88cb582f3e3d8d23127bb71769d20f58750b1e53e42d241d0c0cf43e2ca58a5c54a8db0b6c257bba314de789fc061c1a8496fb
+  metadata.gz: cbdef274f682d103d9c77c12e236fc9ced05fead2ca036d104de9659e8c4c9b976637bdbd6f30308d2054a55dbfc7ae856ae3ad685b3b725a96a49e05b1c9528
+  data.tar.gz: da237b9fca36849ffb4f2e7c63d9371299dfa73993a6656ff1bd1f1d611ac32568b9b9f6aa8a524860376981bb18b56588b673d63ea1c5f4f2cddf732f9f3336

data/README.md

@@ -24,7 +24,7 @@ And then execute:
 By default the component library will assume to use the application layout and CSS file (`application.html.erb` & `application.css`), in addition to some basic styles added by the gem itself. If you wish to override this feature and use a different stylesheet, change the root file path, or the url the library routes to, these can be configued inside an initializer.
 
 ```
-  ComponentLibrary.setup do |config|
+  ComponentLibrary.configure do |config|
     config.application_css = "new_application_css"
     config.root_path       = "new_component_library"
     config.root_directory  = "new_view_directory"
@@ -33,6 +33,47 @@ By default the component library will assume to use the application layout and C
 
 If you want to use a totally different layout for your component library, simply create a new layout named `component_library.html.erb` in your layouts directory and change there as appropriate.
 
+## Multiconfiguration option
+
+It is possible to allow multiple instances of a component library to be created - for example if you wanted to use the same components, but test different stylesheets at different urls:
+
+```
+  ComponentLibrary.configure do |config|
+    config.multiconfigure = [
+      {
+        root_directory: "theme_components",
+        root_path: "theme_1_components",
+        application_css: "theme_1_css"
+      },
+      {
+        root_directory: "theme_components",
+        root_path: "theme_2_components",
+        application_css: "theme_2_css"
+      }
+    ]
+  end
+```
+
+Or if you want entirely different component libraries - for example a library for your public facing site, one for the admin section, and one for another part of your site...:
+
+```
+  ComponentLibrary.configure do |config|
+    config.multiconfigure = [
+      {
+        root_directory: "public_components",
+        root_path: "public-components",
+        application_css: "application_css"
+      },
+      {
+        root_directory: "admin_components",
+        root_path: "admin-components",
+        application_css: "admin_css"
+      },
+      ...
+    ]
+  end
+```
+
 ## Contributing
 
 1. Fork it ( https://github.com/richarcher/component_library/fork )

data/app/controllers/library_controller.rb

@@ -1,18 +1,30 @@
 class LibraryController < ApplicationController
+
+  before_action :assign_variables
+
   layout "component_library"
 
   def index
-    dir = Dir.glob("#{Rails.root}/app/views/#{ComponentLibrary.root_directory}/**/*.erb").sort
-    @component_template = 'componentpattern'
-    @library = Library::Librarian.new(dir, ComponentLibrary.root_directory)
+    dir = Dir.glob("#{Rails.root}/app/views/#{@configuration[:root_directory]}/**/*.erb").sort
+
+    @library = Library::Librarian.new(dir, @configuration[:root_directory])
   end
 
   def show
     suffix = params[:format] == 'erb' ? ".erb" : "/**/*.erb"
-    dir = Dir.glob("#{Rails.root}/app/views/#{ComponentLibrary.root_directory}/#{params[:path]}#{suffix}").sort
-    @component_template = params[:view] == 'isolation' ? 'isolationpattern' : 'componentpattern'
-    @library = Library::Librarian.new(dir, ComponentLibrary.root_directory, params[:path])
+    dir = Dir.glob("#{Rails.root}/app/views/#{@configuration[:root_directory]}/#{params[:path]}#{suffix}").sort
+
+    @library = Library::Librarian.new(dir, @configuration[:root_directory], params[:path])
+
     raise ActionController::RoutingError.new('Not Found') if @library.components.empty?
   end
 
+  private
+
+  def assign_variables
+    @root_path = params[:root_path]
+    @configuration = ComponentLibrary.configuration.for(@root_path)[0]
+    @component_template = params[:view] == 'isolation' ? 'isolationpattern' : 'componentpattern'
+  end
+
 end

data/app/views/layouts/component_library.html.erb

@@ -2,7 +2,7 @@
 <html>
 <head>
   <title>Component</title>
-  <%= stylesheet_link_tag ComponentLibrary.stylesheet_path, ComponentLibrary.application_css, media: 'all' %>
+  <%= stylesheet_link_tag ComponentLibrary.stylesheet_path, @configuration[:application_css], media: 'all' %>
   <%= javascript_include_tag ComponentLibrary.javascript_path %>
   <%= csrf_meta_tags %>
   <meta name="viewport" content="width=device-width, initial-scale=1">

data/app/views/library/_componentpattern.html.erb

@@ -2,7 +2,7 @@
 <% library.components.each do |component| %>
 <p class="pattern--title">
   <% component.paths.each do |path| %>
-    /<%= link_to path[:name], component_path(path[:path]) %>
+    /<%= link_to path[:name], '#' %>
   <% end %>
 </p>
 <div class="pattern" id="<%= component.render.parameterize %>">

data/app/views/library/index.html.erb

@@ -2,5 +2,5 @@
 <% if @library.components.any? %>
 <%= render partial: @component_template, locals: { library: @library }  %>
 <% else %>
-<p>No html components found at <code>/app/view/<%= ComponentLibrary.root_directory %></code></p>
+<p>No html components found at <code>/app/view/<%= ComponentLibrary.configuration.root_directory %></code></p>
 <% end %>

data/config/routes.rb

@@ -1,4 +1,9 @@
 Rails.application.routes.draw do
-  get "#{ComponentLibrary.root_path}/", to: 'library#index', as: "components"
-  get "#{ComponentLibrary.root_path}/*path", to: 'library#show', as: "component"
+  clc = ComponentLibrary.configuration
+  get ':root_path/', to: 'library#index', constraints: lambda { |request|
+    clc.root_paths.any? { |root_path| request.original_fullpath.include?(root_path)}
+  }
+  get ':root_path/*path', to: 'library#show', constraints: lambda { |request|
+      clc.root_paths.any? { |root_path| request.original_fullpath.include?(root_path) }
+  }
 end

data/lib/component_library/version.rb

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

data/lib/component_library.rb

@@ -1,15 +1,24 @@
 require "component_library/engine"
 
 module ComponentLibrary
+
   class << self
-    mattr_accessor :root_directory, :root_path, :application_css
-    self.root_directory = "component"
-    self.root_path = "components"
-    self.application_css = "application"
+    attr_accessor :configuration
   end
 
   def self.setup(&block)
-    yield self
+    puts "DEPRECATION NOTICE: configuration via .setup will be removed in future versions of the Component Library gem. Please use .configure instead."
+    self.configuration ||= Configuration.new
+    yield(configuration)
+  end
+
+  def self.configure(&block)
+    self.configuration ||= Configuration.new
+    yield(configuration)
+  end
+
+  def self.reset
+    @configuration = Configuration.new
   end
 
   def self.stylesheet_path
@@ -19,4 +28,30 @@ module ComponentLibrary
   def self.javascript_path
     '_component_library/library'
   end
-end
+
+  class Configuration
+    attr_accessor :root_directory
+    attr_accessor :root_path
+    attr_accessor :application_css
+    attr_accessor :multiconfigure
+
+    def initialize
+      @root_path = "components"
+      @root_directory = "component"
+      @application_css = "application"
+    end
+
+    def root_paths
+      return multiconfigure.map{|mc| mc[:root_path]} if multiconfigure.present?
+      [@root_path]
+    end
+
+    def for(filter)
+      return multiconfigure.select {|mc| mc[:root_path] == filter } if multiconfigure.present?
+      [{ :root_path => @root_path, :root_directory => @root_directory, :application_css => @application_css }]
+    end
+
+
+  end
+
+end

data/lib/generators/component_library/install/templates/component_library.rb.erb

@@ -1,4 +1,5 @@
-ComponentLibrary.setup do |config|
+ComponentLibrary.configure do |config|
+  config.application_css = 'application'
   config.root_path = '<%= file_name %>'
   config.root_directory = '<%= file_name %>'
 end

data/lib/generators/component_library/install/templates/layout.html.erb

@@ -2,8 +2,7 @@
 <html>
 <head>
   <title>Component</title>
-  <%= stylesheet_link_tag 'application', media: 'all' %>
-  <%= stylesheet_link_tag ComponentLibrary.stylesheet_path, media: 'all' %>
+  <%= stylesheet_link_tag ComponentLibrary.stylesheet_path, @configuration[:application_css], media: 'all' %>
   <meta name="viewport" content="width=device-width, initial-scale=1">
 </head>
 <body>

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: component_library
 version: !ruby/object:Gem::Version
-  version: 1.0.1
+  version: 2.0.0
 platform: ruby
 authors:
 - Rich Archer
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-04-29 00:00:00.000000000 Z
+date: 2016-06-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: sqlite3