tabster 0.1.0

data/LICENSE.txt

@@ -0,0 +1,20 @@
+Copyright (c) 2011 Piotr Murach
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,18 @@
+# Tabster
+
+Tabster is a Ruby generation library that ...
+
+## Contributing to tabster
+
+* Check out the latest master to make sure the feature hasn't been implemented or the bug hasn't been fixed yet
+* Check out the issue tracker to make sure someone already hasn't requested it and/or contributed it
+* Fork the project
+* Start a feature/bugfix branch
+* Commit and push until you are happy with your contribution
+* Make sure to add tests for it. This is important so I don't break it in a future version unintentionally.
+* Please try not to mess with the Rakefile, version, or history. If you want to have your own version, or is otherwise necessary, that is fine, but please isolate to its own commit so I can cherry-pick around it.
+
+## Copyright
+
+Copyright (c) 2011 Piotr Murach. See LICENSE.txt for
+further details.

data/Rakefile

@@ -0,0 +1,45 @@
+# encoding: utf-8
+
+require 'rubygems'
+require 'bundler'
+begin
+  Bundler.setup(:default, :development)
+rescue Bundler::BundlerError => e
+  $stderr.puts e.message
+  $stderr.puts "Run `bundle install` to install missing gems"
+  exit e.status_code
+end
+require 'rake'
+
+require 'jeweler'
+Jeweler::Tasks.new do |gem|
+  # gem is a Gem::Specification... see http://docs.rubygems.org/read/chapter/20 for more options
+  gem.name = "tabster"
+  gem.homepage = "http://github.com/peter-murach/tabster"
+  gem.license = "MIT"
+  gem.summary = %Q{TODO: one-line summary of your gem}
+  gem.description = %Q{TODO: longer description of your gem}
+  gem.email = "pmurach@gmail.com"
+  gem.authors = ["Piotr Murach"]
+  # dependencies defined in Gemfile
+end
+Jeweler::RubygemsDotOrgTasks.new
+
+require 'rspec/core'
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new(:spec) do |spec|
+  spec.pattern = FileList['spec/**/*_spec.rb']
+end
+
+RSpec::Core::RakeTask.new(:rcov) do |spec|
+  spec.pattern = 'spec/**/*_spec.rb'
+  spec.rcov = true
+end
+
+require 'cucumber/rake/task'
+Cucumber::Rake::Task.new(:features)
+
+task :default => :spec
+
+require 'yard'
+YARD::Rake::YardocTask.new

data/features/support/env.rb

@@ -0,0 +1,13 @@
+require 'bundler'
+begin
+  Bundler.setup(:default, :development)
+rescue Bundler::BundlerError => e
+  $stderr.puts e.message
+  $stderr.puts "Run `bundle install` to install missing gems"
+  exit e.status_code
+end
+
+$LOAD_PATH.unshift(File.dirname(__FILE__) + '/../../lib')
+require 'tabster'
+
+require 'rspec/expectations'

data/features/tabster.feature

@@ -0,0 +1,9 @@
+Feature: something something
+  In order to something something
+  A user something something
+  something something something
+
+  Scenario: something something
+    Given inspiration
+    When I create a sweet new gem
+    Then everyone should see how awesome I am

data/lib/generators/tabster/install_generator.rb

@@ -0,0 +1,21 @@
+module Tabster
+  module Generators
+    class InstallGenerator < Rails::Generators::Base
+      source_root File.expand_path("../../templates", __FILE__)
+
+      desc "Creates a Tabster initializer and copies css styles to your application"
+
+      def copy_initializer
+        template 'tabster.rb', 'config/initializers/tabster.rb'
+      end
+
+      def copy_stylesheet
+        copy_file "tabster.css", File.join('app/assets/stylesheets', "#{file_name}.css")
+      end
+
+      def show_readme
+        readme "README" if behavior == :invoke
+      end
+    end
+  end
+end # Tabster

data/lib/generators/templates/tabster.rb

@@ -0,0 +1,22 @@
+# Use this hook to specify the routes for all your tabs
+Tabster.configure do |config|
+  # Configure the name used to identify tabs in your markup.
+  # This can be overwritten when invoking #tabs_for method 
+  # in your views.
+  config.name = :admin
+
+  # Configure routes used for tab generation. Each tab entry
+  # should invoke #add method and pass following parameters
+  # :name and [:path_to].
+  # All paths are loaded in the order of their declartion.
+  config.draw do |map|
+    # map.add :dashboard,  :path_to => '/admin/dashboard'
+
+    # If you want to add second level of tab navigation add
+    # extra block after the #add method call.
+
+    # map.add :posts, :path_to => '/admin/blog/posts' do |nested|
+    #   nested.add :notes, :path_to => '/admin/blog/bla'
+    # end
+  end
+end

data/lib/tabster.rb

@@ -0,0 +1,32 @@
+require 'tabster/configurable'
+require 'tabster/version'
+require 'tabster/helpers'
+
+module Tabster
+  include Tabster::Configurable
+  include Tabster::Version
+
+  SEPARATORS = %w( / )
+  REQUIRED_TAB_FRAGMENTS = [:path_to]
+  ALLOWED_PATH_FRAGMENTS = [:controller, :action]
+
+  class << self
+    delegate :config, :configure, :to => Tabster::Configurable
+
+    def initialize
+      raise "ActionController is not available yet." unless defined?(ActionController)
+      ActionController::Base.send(:include, self)
+      ActionController::Base.send(:helper, Tabster::Helpers)
+    end
+
+    def version
+      Tabster::Version::STRING
+    end
+  end
+end
+
+if defined?(Rails::Railtie)
+  require 'tabster/railtie'
+else
+  Tabster.send(:initialize)
+end

data/lib/tabster/configurable.rb

@@ -0,0 +1,71 @@
+module Tabster
+  module Configurable
+
+    # Holds all the parameters for the Tabster initializer and defaults
+    # that should suite most needs. It's possible to overwrite those as well.
+    # This class is passed through the block running on the Tabster module.
+    class Configuration
+
+      attr_accessor_with_default :name,         :main
+      attr_accessor_with_default :css_template, :main
+      attr_accessor_with_default :helpers,      []
+      attr_accessor_with_default :includes,     []
+      attr_accessor :tab_set
+
+      def initialize
+       initialize_tab_set!
+      end
+
+      def initialize_tab_set!
+        @tab_set = TabSet.new
+      end
+
+      # Reload the tab ordering
+      def reload
+        @tab_set = tab_set.nil? ? nil : tab_set
+      end
+
+      # add class methods to return tabnavs
+      #self.class_eval 
+      #  define_method
+      #end
+
+      def draw
+        yield @tab_set
+        @tab_set
+      end
+
+      def validate!
+        raise ConfigurationError.new("Tab navigation needs name as a String or Symbol \n e.i. config.name = :admin") unless self.name.is_a? String or self.name.is_a? Symbol
+      end
+
+      def configuration_path
+        "#{RAILS_ROOT}/config/initializers/tabacious.rb"
+      end
+
+      class ConfigurationError < StandardError; end
+
+    end # Configuration
+
+    class << self
+
+      attr_reader :config
+
+      def config
+        @@config ||= Configuration.new
+      end
+
+      def configure(&block)
+        raise "configure must be sent a block" unless block_given?
+        yield config
+        config.validate!
+      end
+
+      def to_hash
+        { :name => @@config.name, :css_template => @@config.css_template}
+      end
+
+    end
+
+  end # Configurable
+end # Tabster

data/lib/tabster/helpers.rb

@@ -0,0 +1,59 @@
+module Tabster
+  module Helpers
+    #include CssTemplate
+
+    # Use
+    # <%= tabs_for :name do %>
+    #    ...
+    # <% end %>
+    # or just <%= tabacious :name %>
+    #
+    def tabs_for(name, options = {}, &block)
+      raise ArgumentError, "Missing name parameter in method call." unless name
+      #raise ArgumentError, "Missing block in method call." unless block_given?
+
+      #css_template_name = ::Utility::Config.configuration.css_template
+      #unless css_template_name
+        #concat render_css_template(css_template_name)
+      #end
+      puts "CONTROLLER: #{request.request_uri}"
+      tabnav_name = name.to_s.parameterize.wrapped_string + '_tabnav'
+      html =  content_tag(:div, render_tabnav_tabs(name), :id => "#{tabnav_name}_wrapper")
+      puts "HTML RENDERING: #{html}"
+      if block_given?
+        html << content_tag(:div, capture(&block), :id => "#{tabnav_name}_content") 
+        concat html
+        nil
+      end
+      html
+    end
+
+    private
+
+    def render_tabnav_tabs(tabnav_name)
+      puts "CONFIGURATION : #{::Tabster.config.inspect}"
+      tab_set = ::Tabster.config.tab_set
+      return if tab_set.empty?
+
+      list_items = []
+      tab_set.each do |name, tab|
+        li_options = {}
+        li_options[:id] = "#{name.to_s.parameterize.wrapped_string}_container"
+        #li_options[:class] = tab.highlighted?
+        if tab.path
+          active = request.request_uri =~ %r[#{tab.path}] ? 'active' : ''
+          list_items << content_tag(:li, link_to("#{name.to_s.camelize}", tab.path, :class => active), li_options )
+        else
+          list_items << content_tag(:li, content_tag(:span, "#{name.to_s.camelize}"))
+        end
+      end
+      content_tag(:ul, list_items, :id => "#{tabnav_name.to_s.parameterize.wrapped_string}_tabnav")
+    end
+
+    def config_cache
+      return @config_cache if  @confige_cache
+      @config_cache = ::Utility::Config.configuration
+    end
+
+  end
+end

data/lib/tabster/railtie.rb

@@ -0,0 +1,9 @@
+if defined?(Rails::Railtie)
+  module Tabster
+    class Railtie < Rails::Railtie
+      initializer :tabacious do
+        Tabster.initialize
+      end
+    end
+  end
+end

data/lib/tabster/tab.rb

@@ -0,0 +1,38 @@
+module Tabster
+  class Tab
+    attr_accessor :path
+    attr_accessor :name
+    attr_accessor :tabs
+
+    attr_accessor_with_default :priority,   1
+    attr_accessor_with_default :title,      'default'
+    attr_accessor_with_default :sub_tabnav, []
+
+    def initialize(options = {}, &block)
+      puts " SEGMENTS IN TAB: #{options.inspect}"
+
+      if block_given?
+        @tabs = TabSet.new
+        puts "BLOCK: #{block.inspect}"
+        yield @tabs
+      end
+
+      @path      = options[:path_to] || '/'
+      @highlight = options[:highlights_on] || ''
+      @priority  = options[:priority] || 1
+    end
+
+    def add_tab(name, options, &block)
+      Tabnav.new.add_tab(name, options, &block)
+    end
+
+    def extract_tabs(collection = [])
+      return nil unless collection.is_a? Array
+      collection.map { |item| self.new( { :title => item.title, :path => item.path }) }
+    end
+
+    def freeze
+      self
+    end
+  end #Tab
+end #Tabster

data/lib/tabster/tab_builder.rb

@@ -0,0 +1,65 @@
+#TODO make use of the passed block to create subitems in the navigation.
+
+module Tabster
+  class TabBuilder
+
+    # Construct and return a tab with the given path and options.
+    def build(options, &block)
+      segments = extract_tab_segments(options)
+      puts "EXTRACTED FRAGMENTS: #{segments.inspect}"
+      tab = Tab.new(segments, &block)
+      tab.freeze
+    end
+
+    def extract_tab_segments(options)
+      segments = {}
+      options.each do |key, value|
+        if [:path_to].include?(key)
+          segments[key] = extract_path_segment(value)
+        elsif [:priority].include?(key)
+          segments[key] = value.to_i
+        elsif [:highlights_on].include?(key)
+          if value.is_a? Proc
+            segments[key] = value
+          end
+        end
+      end
+      segments
+    end
+
+    def extract_path_segment(path_to)
+      case path_to.class.to_s
+        when 'String'
+          normalize_path(wrap_path_with_slashes(path_to.to_s))
+        when 'Symbol'
+          normalize_path(wrap_path_with_slashes(path_to.to_s))
+        when 'Hash'
+          # if controller key given, make action an explicit param
+          action = path_to[:action].nil? ? 'index' : path_to[:action]
+          if path_to[:controller] 
+            normalize_path("#{path_to[:controller]}/#{action}")
+          else
+            raise ArgumentError, ":path_to is invalid in tab parameters. Need to specify at least the controller, i.e. :controller => :admin"
+          end
+      end
+    end
+
+    def wrap_path_with_slashes(path)
+      path = "/#{path}" unless path[0] == ?/
+      path = "#{path}/" unless path[-1] == ?/
+    end
+
+    # Returns a path cleaned of double-shlashes and relative path references.
+    def normalize_path(path)
+      path = path.
+        gsub("//", "/"). 
+        gsub("\\\\", "\\").
+        gsub(%r{(.)[\\/]$}, '\1')
+
+      re = %r{[^/\\]+[/\\]\.\.[/\\]}
+      path.gsub!(re, "") while path.match(re)
+      path
+    end
+
+  end # TabBuilder
+end # Tabster

data/lib/tabster/tab_set.rb

@@ -0,0 +1,96 @@
+require 'active_support'
+
+module Tabster
+  class TabSet
+    include Enumerable
+    include ActiveSupport
+
+    attr_reader :tabs
+    attr_reader :name
+
+    def initialize
+      clear!
+    end
+
+    def add(name, options = {}, &block)
+      add_tab(name, options, &block)
+    end
+
+    def add_tab(name, options = {}, &block)
+      puts "ADDING TAB: #{options.inspect}"
+      raise_tab_name_error if name.nil?
+      options = options.dup.symbolize_keys 
+      options.assert_valid_keys(:path_to, :highlights_on, :priority)
+      ensure_required_fragments(options)
+      tab = builder.build(options, &block)
+      @tabs[name.to_sym] = tab
+      tab
+    end
+
+    def ensure_required_fragments(options)
+      Tabster::REQUIRED_TAB_FRAGMENTS.each do |fragment|
+        unless options.has_key? fragment.to_sym
+          raise ArgumentError, "Tab fragment :path_to cannot be optional."
+        end
+      end
+    end
+
+    def builder
+      @builder ||= TabBuilder.new
+    end
+
+    def method_missing(tab_name, *args, &proc)
+      super
+    end
+
+    def get(name)
+      @tabs[name.to_sym]
+    end
+
+    def clear!
+      @tabs = ActiveSupport::OrderedHash.new
+    end
+
+    def tab_names
+      @tabs.keys
+    end
+
+    def each
+      tabs.each { |name, params| yield name, params }
+      self
+    end
+
+    def names
+      tabs.keys
+    end
+
+    def sort!(sort_key = :priority, &block)
+      sort_key = sort_key.to_sym
+      if block_given?
+        tabs.sort &block
+      else
+        tabs.sort { |tab1, tab2| tab1[1][sort_key] <=> tab2[1][sort_key] }
+      end
+    end
+
+    def empty?
+      tabs.empty?
+    end
+
+    def length
+      tabs.length
+    end
+
+    def raise_tab_name_error
+      raise TabRoutingError, "Failed to generate tab from params."  
+    end
+
+    class TabRoutingError < StandardError; end
+    class TabWrongParams < StandardError; end
+
+    alias []= add_tab
+    alias []  get
+    #alias clear clear!
+
+  end # TabSet
+end # Tabster

data/lib/tabster/version.rb

@@ -0,0 +1,9 @@
+module Tabster
+  module Version
+    MAJOR = 0
+    MINOR = 1
+    TINY  = 0
+
+    STRING = [MAJOR, MINOR, TINY].join('.')
+  end # Version
+end # Tabster

data/spec/spec_helper.rb

@@ -0,0 +1,12 @@
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+require 'rspec'
+require 'tabster'
+
+# Requires supporting files with custom matchers and macros, etc,
+# in ./support/ and its subdirectories.
+Dir["#{File.dirname(__FILE__)}/support/**/*.rb"].each {|f| require f}
+
+RSpec.configure do |config|
+  
+end

data/spec/tabster_spec.rb

@@ -0,0 +1,7 @@
+require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
+
+describe "Tabster" do
+  it "fails" do
+    fail "hey buddy, you should probably rename this file and start specing for real"
+  end
+end

metadata

@@ -0,0 +1,157 @@
+--- !ruby/object:Gem::Specification 
+name: tabster
+version: !ruby/object:Gem::Version 
+  prerelease: false
+  segments: 
+  - 0
+  - 1
+  - 0
+  version: 0.1.0
+platform: ruby
+authors: 
+- Piotr Murach
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-11-20 00:00:00 +00:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: rspec
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 2
+        - 4
+        - 0
+        version: 2.4.0
+  type: :development
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: cucumber
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  name: bundler
+  prerelease: false
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 1
+        - 0
+        - 0
+        version: 1.0.0
+  type: :development
+  version_requirements: *id003
+- !ruby/object:Gem::Dependency 
+  name: jeweler
+  prerelease: false
+  requirement: &id004 !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 1
+        - 6
+        - 4
+        version: 1.6.4
+  type: :development
+  version_requirements: *id004
+- !ruby/object:Gem::Dependency 
+  name: simplecov
+  prerelease: false
+  requirement: &id005 !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        - 4
+        version: "0.4"
+  type: :development
+  version_requirements: *id005
+- !ruby/object:Gem::Dependency 
+  name: guard-rspec
+  prerelease: false
+  requirement: &id006 !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id006
+description: "  "
+email: ""
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- Rakefile
+- features/step_definitions/tabster_steps.rb
+- features/support/env.rb
+- features/tabster.feature
+- lib/generators/tabster/install_generator.rb
+- lib/generators/templates/tabster.rb
+- lib/tabster/configurable.rb
+- lib/tabster/helpers.rb
+- lib/tabster/railtie.rb
+- lib/tabster/tab.rb
+- lib/tabster/tab_builder.rb
+- lib/tabster/tab_set.rb
+- lib/tabster/version.rb
+- lib/tabster.rb
+- spec/spec_helper.rb
+- spec/tabster_spec.rb
+- README.md
+- LICENSE.txt
+has_rdoc: true
+homepage: https://github.com/peter-murach/tabster
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.6
+signing_key: 
+specification_version: 3
+summary: Rails tabs generation library
+test_files: []
+