styleus 0.0.10 → 0.0.11

data/app/helpers/external_helper.rb

@@ -6,38 +6,37 @@ module ExternalHelper
   end
 
   def documentation(&block)
-    _cleared_content_for :documentation, _styleus_documentation_wrap(&block)
+    content_for :documentation, _styleus_documentation_wrap(&block)
   end
 
   def display(&block)
-    _cleared_content_for :representation, capture(&block)
+    content_for :representation, capture(&block)
   end
 
   def html(&block)
-    _cleared_content_for :html, _html_representation(&block)
+    content_for :html, _html_representation(&block)
   end
 
   def helper(&block)
-    _cleared_content_for :helper, _helper_representation(&block)
+    content_for :helper, _helper_representation(&block)
   end
 
-  def styleus_page(comp_list = [])
-    return if comp_list.empty?
-    index      = styleus_index(comp_list)
-    components = styleus_components(comp_list)
-    index.concat(components)
+  def styleus_page(&block)
+    index         = styleus_index
+    components    = styleus_components
+    documentation = ''
+    documentation = index_documentation(&block) if block_given?
+    index.concat(documentation).concat(components)
   end
 
-  def styleus_components(comp_list)
-    _build_view_components(comp_list)
-
+  def styleus_components
+    _build_view_components
     @component_list = @components.map { |component| _wrap_component component }
-
     @component_list.join.html_safe
   end
 
-  def styleus_index(comp_list)
-    _build_view_components(comp_list)
+  def styleus_index
+    _build_view_components
     _component_index(components_category, @components)
   end
 end

data/app/helpers/styleus_helper.rb

@@ -1,6 +1,10 @@
 require 'styleus_representer_helper'
 
 module StyleusHelper
+  def _section
+    params[:components]
+  end
+
   def _application_context(&block)
     captured_block = capture(&block)
 
@@ -21,7 +25,7 @@ module StyleusHelper
 
     partial_name = 'component_context'
     partial_path = File.join view_path, 'component_context'
-    file_path   = File.join view_path, "_#{partial_name}.html.erb"
+    file_path    = File.join view_path, "_#{partial_name}.html.erb"
 
     if _partial_exists?(file_path)
       render(layout: partial_path) { captured_block }
@@ -50,36 +54,33 @@ module StyleusHelper
   # and enables the configured content_for blocks for the target
   # partial called styleus_partials.
   def _styleus_partials(component, options = { })
+    _clear_content_for_registrations(:documentation, :representation, :html, :helper)
     # execute application partial without responding it directly,
     # so only the given content_for methods will help.
     render partial: "#{component.partial_path}", locals: { component: component }
 
     # returning concatenating responder partial, which consists of content_for blocks only.
-    render(layout: 'styleus/styleus_partials', locals: { component: component }) { }
-  end
-
-  # To use the render layout: '...' method multiple times
-  # for the several components, including the same content_for
-  # blocks each time, we have to clean up them before registering
-  # the next blocks.
-  #
-  # So this function wraps the content_for function with
-  # a prepended clearing for the specific content_for attribute,
-  # so that earlier defined content_for areas are not
-  # rendered again.
-  def _cleared_content_for(content_name, content)
-    # clear content_for calls for this name
-    @view_flow.set(content_name, '')
+    result = render(layout: 'styleus/styleus_partials', locals: { component: component }) { }
+    flush_output_buffer
+    _clear_content_for_registrations(:documentation, :representation, :html, :helper)
+    result
+  end
 
-    # set new content_for for this name
-    content_for content_name, content
+  # clean up content_for blocks, so same content_for names can be used several times
+  def _clear_content_for_registrations(*content_names)
+    # clear content_for calls for this name
+    content_names.each { |content_name| @view_flow.set(content_name, '') }
   end
 
 
   # converts the list of component hashes configured in the
   # app to a list of ViewComponent instances.
-  def _build_view_components(comp_list)
-    @components ||= Styleus::ViewComponent.from_hashes(comp_list)
+  def _build_view_components
+    @components ||= Styleus::ViewComponent.from_names(_section, _section_class.components)
+  end
+
+  def _section_class
+    _section.camelcase.singularize.constantize
   end
 
   # wraps a component in an article and combines it with
@@ -87,7 +88,7 @@ module StyleusHelper
   # and hide the different partials.
   def _wrap_component(component)
     _styleus_article_wrap(component) do
-      _styleus_partials(component, helper: component.helper?)
+      _styleus_partials(component)
     end
   end
 

data/app/helpers/styleus_representer_helper.rb

@@ -1,6 +1,6 @@
 module StyleusRepresenterHelper
-  def _option_bar(component)
-    _render_styleus('option_bar', locals: { component: component })
+  def _option_bar(component, helper)
+    _render_styleus('option_bar', locals: { component: component, helper: helper })
   end
 
   def _component_index(headline, components)

data/app/models/styleus/component.rb

@@ -1,5 +1,48 @@
 module Styleus
   class Component
-    include Styleus::Spacable
+    class_attribute :_sections, :components, :_section_name
+
+    class << self
+      def components(*new_components)
+        return registered_components if new_components.empty?
+
+        registered_components.push(*new_components).uniq!
+        registered_components
+      end
+
+      def registered_components
+        styleus_sections[section_key] ||= []
+      end
+
+      def styleus_sections
+        ::Styleus::Component.sections
+      end
+
+      def sections
+        self._sections ||= { }
+      end
+
+      def section_key
+        section_name.to_sym
+      end
+
+      def section_name
+        self._section_name ||= to_underscore
+      end
+
+      def to_underscore
+        underscored_module_name
+      end
+
+      private
+
+      def underscored_module_name
+        underscored_name.gsub('/', '_')
+      end
+
+      def underscored_name
+        name.underscore
+      end
+    end
   end
 end

data/app/models/styleus/view_component.rb

@@ -9,10 +9,6 @@ module Styleus
       headline.underscore.gsub(/ /, '_')
     end
 
-    def helper?
-      !!helper
-    end
-
     class << self
       def components
         @components ||= []
@@ -23,6 +19,16 @@ module Styleus
         hashes.each { |comp_hash| components << new(comp_hash) }
         components
       end
+
+      def from_names(section, names)
+        components.clear
+        names.each do |name|
+          components << new(
+                  headline: name.to_s.humanize,
+                  partial_path: File.join('components', section, "#{name}"))
+        end
+        components
+      end
     end
   end
 end

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

@@ -2,8 +2,8 @@
   <nav class="__component_index">
     <h3>Components</h3>
     <ul>
-      <% Styleus::Component.spaces.each do |space| %>
-        <li><%= link_to space.to_s.camelcase, send(:"#{space}_path") %></li>
+      <% Styleus::Component.sections.each do |section, components| %>
+        <li><%= link_to section.to_s.camelcase, send(:"#{section.to_s.pluralize}_path") %></li>
       <% end %>
     </ul>
   </nav>

data/app/views/styleus/_option_bar.html.erb

@@ -3,7 +3,7 @@
     <li><%= link_to t('icons.html'), component_path(component),
                     title: t('links.titles.html'), class: 'icon', data: { toggle: "##{component.id} [data-subject=html-representation]" } %></li>
 
-    <% if component.helper? %>
+    <% if helper %>
       <li><%= link_to t('icons.helper'), component_path(component),
                       title: t('links.titles.helper'), class: 'icon', data: { toggle: "##{component.id} [data-subject=ruby-representation]" } %></li>
     <% end %>

data/app/views/styleus/_styleus_partials.html.erb

@@ -5,7 +5,7 @@
 <% end %>
 
 <section class="__code_partials">
-  <%= _option_bar(component) %>
+  <%= _option_bar(component, content_for?(:helper)) %>
   <%= _styleus_component_wrap(partial_path: component.partial_path) { content_for(:representation).html_safe } %>
   <%= content_for(:html).html_safe %>
   <%= content_for(:helper).html_safe %>

data/config/initializers/zz_preload_models.rb

@@ -0,0 +1,15 @@
+# We preload the models here, to let their component registration take effect
+# on the routes builded by their categories later.
+
+# TODO: to be discussed, how to handle this better.
+# this active code can break applications, if their libraries depend on later initializers.
+# after_initialization before routing would be the best.
+
+Rails.configuration.after_initialize do
+  model_path = Rails.root.join 'app/models'
+
+  Dir.open(model_path).each do |file_handler|
+    file_path = model_path.join(file_handler)
+    require file_path if File.file?(file_path) && file_handler =~ /.*\.rb/
+  end
+end

data/config/routes.rb

@@ -1,8 +1,9 @@
 Rails.application.routes.draw do
   resources :components, only: [:index, :show] do
     collection do
-      Styleus::COMPONENT_SPACES.each do |c|
-        resources c, only: [:index, :show], controller: :components, components: c.to_s
+      Styleus::Component.sections.each do |section, _|
+        section_route = section.to_s.pluralize
+        resources section_route, only: [:index, :show], controller: :components, components: section_route
       end
     end
   end

data/lib/styleus.rb

@@ -1,5 +1,4 @@
 require "styleus/engine"
-require "styleus/spacable"
 
 module Styleus
 end

data/lib/styleus/engine.rb

@@ -8,7 +8,6 @@ module Styleus
       app.config.assets.precompile += ['styleus.css']
     end
 
-
     class Configuration < OpenStruct
       def to_s
         instance_variable_get(:@table).to_s

data/lib/styleus/version.rb

@@ -1,3 +1,3 @@
 module Styleus
-  VERSION = "0.0.10"
+  VERSION = "0.0.11"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: styleus
 version: !ruby/object:Gem::Version
-  version: 0.0.10
+  version: 0.0.11
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-12-18 00:00:00.000000000 Z
+date: 2012-12-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -120,11 +120,10 @@ files:
 - app/views/styleus/_screen_size_viewer.html.erb
 - app/views/styleus/_styleus_partials.html.erb
 - config/initializers/01_styleus_config.rb
-- config/initializers/02_init_container_routes.rb
+- config/initializers/zz_preload_models.rb
 - config/locales/en.yml
 - config/routes.rb
 - lib/styleus/engine.rb
-- lib/styleus/spacable.rb
 - lib/styleus/version.rb
 - lib/styleus.rb
 - MIT-LICENSE
@@ -150,7 +149,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.24
+rubygems_version: 1.8.23
 signing_key: 
 specification_version: 3
 summary: Styleguide Support Tool

data/config/initializers/02_init_container_routes.rb

@@ -1 +0,0 @@
-Styleus::COMPONENT_SPACES = Styleus::Component.spaces || []

data/lib/styleus/spacable.rb

@@ -1,14 +0,0 @@
-module Styleus
-  module Spacable
-    extend ActiveSupport::Concern
-
-    module ClassMethods
-      def spaces(*collection)
-        @spaces ||= []
-        return @spaces if collection.empty?
-        @spaces.concat(collection).uniq! if collection.respond_to? :to_ary
-        @spaces
-      end
-    end
-  end
-end