openstax_utilities 0.0.4 → 0.0.5

data/README.md

@@ -3,4 +3,6 @@ OpenstaxUtilities
 
 A set of common utilities for the various OpenStax projects.  
 
-Documentation available on [rdoc.info](http://rdoc.info/github/openstax/openstax_utilities/master/frames).
+Documentation available on [rdoc.info](http://rdoc.info/github/openstax/openstax_utilities/master/frames).
+
+To use this utility engine, include it in your Gemfile.

data/app/assets/stylesheets/openstax_utilities.css

@@ -0,0 +1,4 @@
+/*
+ *= require_self
+ *= require_tree .
+ */

data/app/assets/stylesheets/section_block.css.scss

@@ -0,0 +1,33 @@
+// Copyright 2011-2013 Rice University. Licensed under the Affero General Public 
+// License version 3 or later.  See the COPYRIGHT file for details.
+
+@mixin section-block-base($heading_font_size:16px, $heading_color:black, $body_indent:0px, $body_top_margin:8px) {
+  margin:  10px 0px;
+
+  .section-block-heading {
+
+    color:     $heading_color;
+    font-size: $heading_font_size;
+
+    a { 
+      font-size: $heading_font_size; 
+    }
+  }
+
+  .section-block-body {
+    margin:  $body_top_margin 0px 0px;
+    padding: 0px 0px 0px $body_indent;
+  }
+}
+
+.section-block-section {
+  @include section-block-base(16px);
+}
+
+.section-block-section.nesting-2 {
+  @include section-block-base(14px);
+
+  .section-block-heading {
+    font-style: italic;
+  }
+}

data/app/helpers/block_helper.rb

@@ -0,0 +1,22 @@
+# Copyright 2011-2013 Rice University. Licensed under the Affero General Public 
+# License version 3 or later.  See the COPYRIGHT file for details.
+
+module BlockHelper
+
+  def section_block(heading=nil, &block)
+    presenter = OpenStax::Utilities::Blocks::SectionBlock.new(self, heading, block)
+  end
+
+  def table_block(&block)
+    presenter = TableBlock.new(self, block)
+  end
+
+  def table_row_block(&block)
+    presenter = TableRowBlock.new(self, block)
+  end
+
+  def table_cell_block(&block)
+    presenter = TableCellBlock.new(self, block)
+  end
+
+end

data/app/helpers/partial_helper.rb

@@ -0,0 +1,9 @@
+module PartialHelper
+
+  def block_to_partial(partial_name, options={}, &block)
+    options.merge!(:body => capture(&block))
+    render(:partial => partial_name, :locals => options)
+  end
+
+
+end

data/app/views/osu/shared/_section.html.erb

@@ -0,0 +1,17 @@
+<%# Copyright 2011-2013 Rice University. Licensed under the Affero General Public 
+    License version 3 or later.  See the COPYRIGHT file for details. %>
+
+<div <%= block.section_id_attr %> <%= block.section_class_attr %> >
+
+  <% if block.show_heading? %>
+    <div <%= block.heading_class_attr %> >
+      <%= block.heading %>
+    </div>
+  <% end %>
+
+  <div <%= block.body_class_attr %> >
+    <%= block.captured_block %>
+  </div>
+
+</div>
+

data/app/views/osu/shared/_table.html.erb

@@ -0,0 +1,22 @@
+<%# Copyright 2011-2013 Rice University. Licensed under the Affero General Public 
+    License version 3 or later.  See the COPYRIGHT file for details. %>
+
+<table <%= block.table_id_attr %> <%= block.table_class_attr %> >
+  <% if block.show_caption? %>
+    <caption <%= block.caption_class_attr %> >
+      <%= block.title %>
+    </caption>
+  <% end %>
+
+  <tr <%= block.heading_row_class_attr %> >
+    <% block.column_names.each do |column_name| %>
+      <th <%= block.heading_cell_class_attr %> >
+        <%= column_name %>
+      </th>
+    <% end %>
+  </tr>
+
+  <% block.row_blocks.each do |row_block| %>
+    <%= row_block %>
+  <% end %>
+</table>

data/app/views/osu/shared/_table_cell.html.erb

@@ -0,0 +1,6 @@
+<%# Copyright 2011-2013 Rice University. Licensed under the Affero General Public 
+    License version 3 or later.  See the COPYRIGHT file for details. %>
+
+<td <%= block.td_id_attr %> <%= block.td_class_attr %> <%= block.td_colspan_attr %> >
+  <%= block.captured_block %>
+</td>

data/app/views/osu/shared/_table_row.html.erb

@@ -0,0 +1,8 @@
+<%# Copyright 2011-2013 Rice University. Licensed under the Affero General Public 
+    License version 3 or later.  See the COPYRIGHT file for details. %>
+
+<tr>
+  <% block.cell_blocks.each do |cb| %>
+    <%= cb %>
+  <% end %>
+</tr>

data/lib/openstax/utilities/blocks/block_base.rb

@@ -0,0 +1,36 @@
+# Copyright 2011-2013 Rice University. Licensed under the Affero General Public 
+# License version 3 or later.  See the COPYRIGHT file for details.
+   
+module OpenStax::Utilities::Blocks 
+  class BlockBase
+    include Attribeautiful
+
+    attr_accessor :captured_block
+
+    def initialize(template, partial, passed_block)
+      self.h            = template
+      self.passed_block = passed_block
+      self.partial      = partial
+    end
+
+    def to_s
+      render_passed_block
+      render_partial
+    end
+
+  protected
+
+    attr_accessor :h
+    attr_accessor :passed_block
+    attr_accessor :partial
+
+    def render_passed_block
+      self.captured_block ||= h.capture self, &passed_block
+    end
+
+    def render_partial
+      h.render :partial => "osu/shared/#{partial}", :locals => { :block => self }
+    end
+
+  end
+end

data/lib/openstax/utilities/blocks/section_block.rb

@@ -0,0 +1,60 @@
+# Copyright 2011-2013 Rice University. Licensed under the Affero General Public 
+# License version 3 or later.  See the COPYRIGHT file for details.
+
+module OpenStax::Utilities::Blocks
+  class SectionBlock < BlockBase
+
+    html_element :section
+    html_element :heading
+    html_element :body
+
+    attr_accessor :heading
+    attr_accessor :nesting
+    attr_accessor :top_bar
+
+    def initialize(template, heading, block)
+      super(template, "section", block)
+
+      set_heading(heading) if !heading.blank?
+      section_class_add "section-block-section"
+      heading_class_add "section-block-heading"
+      body_class_add    "section-block-body"
+    end
+
+    def set_heading(string)
+      self.heading = string
+      self
+    end
+
+    def set_nesting(depth)
+      self.nesting = depth
+      self
+    end
+
+    def set_top_bar
+      raise "SectionBlock top bar cannot be changed once initialized" \
+        if @top_bar
+      section_class_add "bar-top"
+      self.top_bar = true
+      self
+    end
+
+    def heading=(string)
+      raise "SectionBlock heading cannot be changed once initialized" \
+        if @heading
+      @heading = string
+    end
+
+    def nesting=(depth)
+      raise "SectionBlock nesting cannot be changed once initialized" \
+        if @nesting
+      section_class_add "nesting-#{depth}"
+      @nesting = depth
+    end
+
+    def show_heading?
+      heading.present?
+    end
+
+  end
+end

data/lib/openstax/utilities/blocks/table_block.rb

@@ -0,0 +1,74 @@
+# Copyright 2011-2013 Rice University. Licensed under the Affero General Public 
+# License version 3 or later.  See the COPYRIGHT file for details.
+
+module OpenStax::Utilities::Blocks
+  class TableBlock < BlockBase
+
+    html_element :table
+    html_element :caption
+    html_element :heading_row
+    html_element :heading_cell
+
+    attr_reader :column_names
+    attr_reader :row_blocks
+    attr_reader :title
+
+    def initialize(template, block)
+      super(template, "table", block)
+      self.column_names = []
+      self.row_blocks   = []
+
+      self.table_class_add "table-block-table"
+
+    end
+
+    def set_title(table_title)
+      self.title = table_title
+      self
+    end
+
+    def title=(table_title)
+      raise "TableBlock title cannot be changed once initialized" \
+        if @title
+      @title = table_title
+    end
+
+    def add_column(column_name)
+      self.column_names << column_name
+      self
+    end
+
+    def add_row_block(&block)
+      self.row_blocks << h.table_row_block(&block)
+      self
+    end
+
+    def add_row(*args)
+      trb = h.table_row_block do |rb|
+        args.each do |arg|
+          rb.add_cell(arg)
+        end
+      end
+      self.row_blocks << trb
+      self
+    end
+
+    def add_section_heading(heading)
+      trb = h.table_row_block do |rb|
+        rb.set_section_heading(heading, column_names.count)
+      end
+      self.row_blocks << trb
+      self    
+    end
+
+    def show_caption?
+      title.present?
+    end
+
+  protected
+
+    attr_writer :column_names
+    attr_writer :row_blocks
+
+  end
+end

data/lib/openstax/utilities/blocks/table_cell_block.rb

@@ -0,0 +1,26 @@
+# Copyright 2011-2013 Rice University. Licensed under the Affero General Public 
+# License version 3 or later.  See the COPYRIGHT file for details.
+
+module OpenStax::Utilities::Blocks
+  class TableCellBlock < BlockBase
+
+    html_element :td
+
+    def initialize(template, block)
+      super(template, "table_cell", block)
+    end
+
+    def self.from_value(template, value)
+      tcb = TableCellBlock.new(template, Proc.new {})
+      tcb.captured_block = value
+      tcb
+    end
+
+    def set_section_heading(colspan)
+      self.td_class_add "section-heading"
+      self.td_colspan_add colspan
+      self
+    end
+
+  end
+end

data/lib/openstax/utilities/blocks/table_row_block.rb

@@ -0,0 +1,49 @@
+# Copyright 2011-2013 Rice University. Licensed under the Affero General Public 
+# License version 3 or later.  See the COPYRIGHT file for details.
+
+module OpenStax::Utilities::Blocks
+  class TableRowBlock < BlockBase
+
+    attr_reader :cell_blocks
+    attr_reader :section_heading
+
+    def initialize(template, block)
+      super(template, "table_row", block)
+      self.cell_blocks     = []
+      self.section_heading = false
+    end
+
+    def add_cell_block(&block)
+      self.cell_blocks << h.table_cell_block(&block)
+      self
+    end
+
+    def add_cell(value)
+      self.cell_blocks << TableCellBlock.from_value(h, value)
+    end
+
+    def section_heading?
+      section_heading
+    end
+
+    def set_section_heading(heading, colspan)
+      raise "TableRowBlock cannot be a table section heading if it contains cells" \
+        if cell_blocks.any?
+      raise "TableRowBlock section heading cannot be changed once initialized" \
+        if section_heading?
+
+      tcb = TableCellBlock.from_value(h, heading)
+      tcb.set_section_heading(colspan)
+      self.cell_blocks << tcb
+
+      self.section_heading = true
+      self
+    end
+
+  protected
+
+    attr_writer :cell_blocks
+    attr_writer :section_heading
+
+  end
+end

data/lib/openstax/utilities/engine.rb

@@ -1,6 +1,13 @@
 module OpenStax
   module Utilities
     class Engine < ::Rails::Engine
+      # isolate_namespace OpenStax::Utilities
+
+      initializer "openstax_utilities.assets.precompile" do |app|
+        app.config.assets.precompile += %w(openstax_utilities.css openstax_utilities.js)
+      end
     end
   end
 end
+
+OSU = OpenStax::Utilities

data/lib/openstax/utilities/version.rb

@@ -1,5 +1,5 @@
 module OpenStax
   module Utilities
-    VERSION = "0.0.4"
+    VERSION = "0.0.5"
   end
 end

data/lib/openstax_utilities.rb

@@ -2,4 +2,57 @@ require "openstax/utilities/engine"
 require "openstax/utilities/version"
 require "openstax/utilities/exceptions"
 require "openstax/utilities/settings"
-require "openstax/utilities/access"
+require "openstax/utilities/access"
+
+require 'openstax/utilities/blocks/block_base'
+require 'openstax/utilities/blocks/section_block'
+require 'openstax/utilities/blocks/table_block'
+require 'openstax/utilities/blocks/table_cell_block'
+require 'openstax/utilities/blocks/table_row_block'
+
+module OpenStax
+  module Utilities
+
+    # ASSET_FILES = %w(openstax_utilities.css openstax_utilities.js)
+
+    # ActiveSupport.on_load(:before_initialize) do
+    #   Rails.configuration.assets.precompile += OpenStax::Utilities::ASSET_FILES
+    # end
+
+    class << self
+
+      ###########################################################################
+      #
+      # Configuration machinery.
+      #
+      # To configure OpenStax Utilities, put the following code in your applications 
+      # initialization logic (eg. in the config/initializers in a Rails app)
+      #
+      #   OpenStax::Utilities.configure do |config|
+      #     config.<parameter name> = <parameter value>
+      #     ...
+      #   end
+      #
+      
+      def configure
+        yield configuration
+      end
+
+      def configuration
+        @configuration ||= Configuration.new
+      end
+
+      class Configuration
+        # attr_accessor :some_parameter_name_here
+        
+        def initialize      
+          # @some_parameter_name_here = some value here
+          super
+        end
+      end
+
+    end
+
+  end
+end
+

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: openstax_utilities
 version: !ruby/object:Gem::Version
-  version: 0.0.4
+  version: 0.0.5
   prerelease: 
 platform: ruby
 authors:
@@ -9,8 +9,24 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-05-27 00:00:00.000000000 Z
-dependencies: []
+date: 2013-06-18 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '3.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '3.1'
 description: Utilities for OpenStax web sites
 email:
 - jps@kindlinglabs.com
@@ -18,7 +34,21 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- app/assets/javascripts/openstax_utilities.js
+- app/assets/stylesheets/openstax_utilities.css
+- app/assets/stylesheets/section_block.css.scss
+- app/helpers/block_helper.rb
+- app/helpers/partial_helper.rb
+- app/views/osu/shared/_section.html.erb
+- app/views/osu/shared/_table.html.erb
+- app/views/osu/shared/_table_cell.html.erb
+- app/views/osu/shared/_table_row.html.erb
 - lib/openstax/utilities/access.rb
+- lib/openstax/utilities/blocks/block_base.rb
+- lib/openstax/utilities/blocks/section_block.rb
+- lib/openstax/utilities/blocks/table_block.rb
+- lib/openstax/utilities/blocks/table_cell_block.rb
+- lib/openstax/utilities/blocks/table_row_block.rb
 - lib/openstax/utilities/development.rb
 - lib/openstax/utilities/engine.rb
 - lib/openstax/utilities/exceptions.rb
@@ -69,12 +99,18 @@ required_ruby_version: !ruby/object:Gem::Requirement
   - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
+      segments:
+      - 0
+      hash: -4255439280706106682
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
   - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
+      segments:
+      - 0
+      hash: -4255439280706106682
 requirements: []
 rubyforge_project: 
 rubygems_version: 1.8.24