openstax_utilities 0.0.7 → 1.0.0

data/README.md

@@ -5,4 +5,8 @@ A set of common utilities for the various OpenStax projects.
 
 Documentation available on [rdoc.info](http://rdoc.info/github/openstax/openstax_utilities/master/frames).
 
-To use this utility engine, include it in your Gemfile.
+To use this utility engine, include it in your Gemfile.
+
+## Helpers
+
+This engine's helpers are available in the main application by preceding them with `osu.`, e.g. `osu.section_block('Heading') { "guts" }`

data/app/helpers/openstax/utilities/osu_helper.rb

@@ -0,0 +1,13 @@
+module OpenStax::Utilities
+  module OsuHelper
+
+    def osu
+      @@osu_class ||= Class.new(ClassyHelper) do
+        include OpenStax::Utilities::Helpers::Blocks
+      end
+
+      @@osu_class.new(self)
+    end
+
+  end
+end

data/lib/openstax/utilities/classy_helper.rb

@@ -0,0 +1,16 @@
+module OpenStax::Utilities
+
+  class ClassyHelper < SimpleDelegator
+
+    def initialize(helper_self)
+      @helper_self = helper_self
+      super(helper_self)
+    end
+
+    def true_self
+      @helper_self
+    end
+
+  end
+
+end

data/lib/openstax/utilities/engine.rb

@@ -2,10 +2,12 @@ ActiveSupport::Inflector.inflections do |inflect|
   inflect.acronym 'OpenStax'
 end
 
+OSU = OpenStax::Utilities
+
 module OpenStax
   module Utilities
     class Engine < ::Rails::Engine
-      # isolate_namespace OpenStax::Utilities
+      isolate_namespace OpenStax::Utilities
 
       initializer "openstax_utilities.assets.precompile" do |app|
         app.config.assets.precompile += %w(openstax_utilities.css openstax_utilities.js)
@@ -13,12 +15,11 @@ module OpenStax
 
       initializer 'openstax_utilities.action_controller' do |app|
         ActiveSupport.on_load :action_controller do
-          helper BlockHelper
-          helper PartialHelper
+          helper OSU::OsuHelper
         end
       end
     end
   end
 end
 
-OSU = OpenStax::Utilities
+

data/lib/openstax/utilities/exceptions.rb

@@ -3,4 +3,5 @@ class AbstractMethodCalled < StandardError; end
 class NotYetImplemented < StandardError; end
 class IllegalArgument < StandardError; end
 class IllegalState < StandardError; end
-class IllegalOperation < StandardError; end
+class IllegalOperation < StandardError; end
+class Unexpected < StandardError; end

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

@@ -0,0 +1,24 @@
+# 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::Helpers
+  module Blocks
+
+    def section_block(heading=nil, &block)
+      presenter = OpenStax::Utilities::Blocks::SectionBlock.new(true_self, heading, block)
+    end
+
+    def table_block(&block)
+      presenter = TableBlock.new(true_self, block)
+    end
+
+    def table_row_block(&block)
+      presenter = TableRowBlock.new(true_self, block)
+    end
+
+    def table_cell_block(&block)
+      presenter = TableCellBlock.new(true_self, block)
+    end
+
+  end
+end

data/lib/openstax/utilities/helpers/partials.rb

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

data/lib/openstax/utilities/ruby.rb

@@ -5,4 +5,8 @@ module Kernel
       self
     end
   end
+
+  def includes_module?(mod)
+    eigenclass.included_modules.include?(mod)
+  end
 end

data/lib/openstax/utilities/text.rb

@@ -0,0 +1,12 @@
+module OpenStax
+  module Utilities
+    module Text
+
+      def self.copyright(start_year, holder)
+        year_range = "#{start_year}-#{Time.now.year}".sub(/\A(\d+)-\1\z/, '\1');
+        "Copyright © #{year_range} #{holder}".html_safe
+      end
+
+    end
+  end
+end

data/lib/openstax/utilities/version.rb

@@ -1,5 +1,5 @@
 module OpenStax
   module Utilities
-    VERSION = "0.0.7"
+    VERSION = "1.0.0"
   end
 end

data/lib/openstax_utilities.rb

@@ -5,6 +5,11 @@ require "openstax/utilities/settings"
 require "openstax/utilities/access"
 require "openstax/utilities/enum"
 require "openstax/utilities/ruby"
+require "openstax/utilities/text"
+
+require "openstax/utilities/classy_helper"
+require "openstax/utilities/helpers/blocks"
+require "openstax/utilities/helpers/partials"
 
 require 'openstax/utilities/blocks/block_base'
 require 'openstax/utilities/blocks/section_block'

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: openstax_utilities
 version: !ruby/object:Gem::Version
-  version: 0.0.7
+  version: 1.0.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-09-18 00:00:00.000000000 Z
+date: 2013-10-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -52,8 +52,7 @@ extra_rdoc_files: []
 files:
 - app/assets/javascripts/openstax_utilities.js
 - app/assets/stylesheets/openstax_utilities.css
-- app/helpers/block_helper.rb
-- app/helpers/partial_helper.rb
+- app/helpers/openstax/utilities/osu_helper.rb
 - app/views/osu/shared/_section.html.erb
 - app/views/osu/shared/_table.html.erb
 - app/views/osu/shared/_table_cell.html.erb
@@ -64,12 +63,16 @@ files:
 - 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/classy_helper.rb
 - lib/openstax/utilities/development.rb
 - lib/openstax/utilities/engine.rb
 - lib/openstax/utilities/enum.rb
 - lib/openstax/utilities/exceptions.rb
+- lib/openstax/utilities/helpers/blocks.rb
+- lib/openstax/utilities/helpers/partials.rb
 - lib/openstax/utilities/ruby.rb
 - lib/openstax/utilities/settings.rb
+- lib/openstax/utilities/text.rb
 - lib/openstax/utilities/version.rb
 - lib/openstax_utilities.rb
 - MIT-LICENSE
@@ -105,7 +108,8 @@ files:
 - test/dummy/script/rails
 - test/integration/navigation_test.rb
 homepage: http://github.com/openstax/openstax_utilities
-licenses: []
+licenses:
+- MIT
 post_install_message: 
 rdoc_options: []
 require_paths:
@@ -118,7 +122,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -491942878868703970
+      hash: -335610188328766728
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
@@ -127,7 +131,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -491942878868703970
+      hash: -335610188328766728
 requirements: []
 rubyforge_project: 
 rubygems_version: 1.8.24

data/app/helpers/block_helper.rb

@@ -1,22 +0,0 @@
-# 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 osu_section_block(heading=nil, &block)
-    presenter = OpenStax::Utilities::Blocks::SectionBlock.new(self, heading, block)
-  end
-
-  def osu_table_block(&block)
-    presenter = TableBlock.new(self, block)
-  end
-
-  def osu_table_row_block(&block)
-    presenter = TableRowBlock.new(self, block)
-  end
-
-  def osu_table_cell_block(&block)
-    presenter = TableCellBlock.new(self, block)
-  end
-
-end

data/app/helpers/partial_helper.rb

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