simple_show 0.0.1

data/.gitignore

@@ -0,0 +1,4 @@
+*.gem
+.bundle
+Gemfile.lock
+pkg/*

data/.rvmrc

@@ -0,0 +1 @@
+rvm gemset use simple_show

data/Gemfile

@@ -0,0 +1,11 @@
+source "http://rubygems.org"
+
+group :test do
+  gem 'rake', '0.8.7'
+  gem 'rails'
+  gem 'sqlite3'
+  gem 'nokogiri'
+end
+
+# Specify your gem's dependencies in simple_show.gemspec
+gemspec

data/README.rdoc

@@ -0,0 +1,95 @@
+== simple_show
+
+* http://github.com/phallstrom/simple_show
+
+== Description:
+
+SimpleShow is to #show as SimpleForm is to #new/#edit.
+
+== Requirements:
+
+* Rails 3
+
+== Install:
+
+Add it to your Gemfile:
+
+    gem "simple_show"
+
+Update your bundle:
+
+    bundle update simple_show
+
+Run the generator:
+
+    rails generate simple_show:install
+
+== Example Usage:
+
+Assume we have a Person object with name, phone, email, born_on, etc.
+In our show action we can then do this:
+
+    <%= simple_show_for @johndoe do |f| %>
+      <%= f.show :name %>
+      <%= f.show :phone, :label => 'Telephone' %>
+      <%= f.show(:email) {|o| o.email.downcase}  %>
+      <%= f.show :born_on, :value => '**censored**'  %>
+    <% end %>
+
+Which would generate (using the defaults) output like this:
+
+    <div class="simple_show person" id="person_123">
+      <div class="show">
+        <label>Name:</label>
+        <span class="value">John Doe</span>
+      </div>
+      <div class="show">
+        <label>Telephone:</label>
+        <span class="value">867-5309</span>
+      </div>
+      <div class="show">
+        <label>Email:</label>
+        <span class="value">johndoe@example.com</span>
+      </div>
+      <div class="show">
+        <label>Born on:</label>
+        <span class="value">**censored**</span>
+      </div>
+      <br clear="all">
+    </div>
+
+== Options:
+
+There are a number of options that control the resulting HTML.
+See lib/simple_show.rb for what they are.  For example,
+if you don't want that BR tag then set SimpleShow.clear_on_close to false.
+
+== TODO:
+
+- Add support for associations.
+- Add options for formatting dates, numerics, decimals, and booleans.
+
+== License:
+
+(The MIT License)
+
+Copyright (c) 2011 Philip Hallstrom <philip@pjkh.com>
+
+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/Rakefile

@@ -0,0 +1,10 @@
+require 'bundler'
+Bundler::GemHelper.install_tasks
+
+require 'rake/testtask'
+Rake::TestTask.new(:test) do |test|
+  test.libs << 'lib' 
+  test.libs << 'test'
+  test.pattern = 'test/**/test_*.rb'
+  test.verbose = true
+end

data/app/helpers/simple_show/application_helper.rb

@@ -0,0 +1,16 @@
+module SimpleShow
+  module ApplicationHelper
+    def simple_show_for(record, options = {}, &block)
+      raise ArgumentError, "Missing block" unless block_given?
+
+      options[:html] ||= {}
+      options[:html][:id] ||= dom_id(record)
+      options[:html][:class] = "#{SimpleShow.show_class} #{dom_class(record)} #{options[:html][:class]}".strip
+
+      output = capture(SimpleShow::Base.new(self, record, options), &block)
+      output.concat tag(:br, :clear => 'all') if SimpleShow.clear_on_close
+
+      content_tag(:div, output, :id => options[:html][:id], :class => options[:html][:class])
+    end
+  end
+end

data/lib/generators/simple_show/USAGE

@@ -0,0 +1,3 @@
+To copy a SimpleShow initializer to your Rails App, with some configuration values, just do:
+
+    rails generate simple_show:install

data/lib/generators/simple_show/install_generator.rb

@@ -0,0 +1,13 @@
+module SimpleShow
+  module Generators
+    class InstallGenerator < Rails::Generators::Base
+      desc "Copy SimpleShow configuration"
+      source_root File.expand_path('../templates', __FILE__)
+
+      def copy_config
+        directory 'config'
+      end
+
+    end
+  end
+end

data/lib/generators/simple_show/templates/config/initializers/simple_show.rb

@@ -0,0 +1,17 @@
+# Use this setup block to configure all options available in SimpleShow.
+SimpleShow.setup do |config|
+
+ #config.show_class     = :simple_show
+ #config.wrapper_tag    = :div
+ #config.wrapper_class  = :show
+ #config.label_tag      = :label
+ #config.label_class    = nil
+ #config.label_prefix   = nil
+ #config.label_suffix   = ':'
+ #config.value_tag      = :span
+ #config.value_class    = :value
+ #config.value_prefix   = nil
+ #config.value_suffix   = nil
+ #config.clear_on_close = true
+
+end

data/lib/simple_show/base.rb

@@ -0,0 +1,36 @@
+module SimpleShow
+  class Base
+    def initialize(binding, record, options = {})
+      @binding = binding
+      @record  = record
+      @options = options
+    end
+
+    def show(attr, options = {}, &block)
+      output = label(attr, options, &block)
+      output += value(attr, options, &block)
+      if SimpleShow.wrapper_tag.nil?
+        @binding.output_buffer += output
+      else
+        @binding.output_buffer += @binding.content_tag(SimpleShow.wrapper_tag, output, :class => SimpleShow.wrapper_class)
+      end
+    end
+
+    def label(attr, options = {}, &block)
+      @binding.content_tag(SimpleShow.label_tag, :class => SimpleShow.label_class) do
+        [SimpleShow.label_prefix, options[:label] || @record.class.human_attribute_name(attr), SimpleShow.label_suffix].compact.join
+      end
+    end
+
+    def value(attr, options = {}, &block)
+      if block_given?
+        value = yield(@record)
+      else
+        value = options[:value] || @record.send(attr)
+      end
+      @binding.content_tag(SimpleShow.value_tag, :class => SimpleShow.value_class) do
+        [SimpleShow.value_prefix, value, SimpleShow.value_suffix].compact.join
+      end
+    end
+  end
+end

data/lib/simple_show/railtie.rb

@@ -0,0 +1,9 @@
+module SimpleShow
+  class Engine < Rails::Engine
+    initializer "simple_show.setup" do
+      config.to_prepare do
+        ApplicationController.helper(::SimpleShow::ApplicationHelper)
+      end
+    end
+  end
+end

data/lib/simple_show/version.rb

@@ -0,0 +1,3 @@
+module SimpleShow
+  VERSION = "0.0.1"
+end

data/lib/simple_show.rb

@@ -0,0 +1,52 @@
+require 'action_view'
+require 'simple_show/base'
+
+if defined?(::Rails::Railtie)
+  require 'simple_show/railtie'
+end
+
+module SimpleShow
+
+  mattr_accessor :show_class
+  @@show_class = :simple_show
+
+  mattr_accessor :wrapper_tag
+  @@wrapper_tag = :div
+
+  mattr_accessor :wrapper_class
+  @@wrapper_class = :show
+
+  mattr_accessor :label_tag
+  @@label_tag = :label
+
+  mattr_accessor :label_class
+  @@label_class = nil
+
+  mattr_accessor :label_prefix
+  @@label_prefix = nil
+
+  mattr_accessor :label_suffix
+  @@label_suffix = ':'
+
+  mattr_accessor :value_tag
+  @@value_tag = :span
+
+  mattr_accessor :value_class
+  @@value_class = :value
+
+  mattr_accessor :value_prefix
+  @@value_prefix = nil
+
+  mattr_accessor :value_suffix
+  @@value_suffix = nil
+
+  mattr_accessor :clear_on_close
+  @@clear_on_close = true
+
+  # Default way to setup SimpleShow. Run rails generate simple_show:install
+  # to create a fresh initializer with all configuration values.
+  def self.setup
+    yield self
+  end
+
+end

data/simple_show.gemspec

@@ -0,0 +1,21 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "simple_show/version"
+
+Gem::Specification.new do |s|
+  s.name        = "simple_show"
+  s.version     = SimpleShow::VERSION
+  s.platform    = Gem::Platform::RUBY
+  s.authors     = ["Philip Hallstrom"]
+  s.email       = ["philip@pjkh.com"]
+  s.homepage    = ""
+  s.summary     = %q{SimpleShow is #new what SimpleForm is to #edit}
+  s.description = %q{SimpleShow is #new what SimpleForm is to #edit}
+
+  s.rubyforge_project = "simple_show"
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = ["lib"]
+end

data/test/test_helper.rb

@@ -0,0 +1,60 @@
+require 'rubygems'
+require 'bundler/setup'
+require 'nokogiri'
+
+require 'test/unit'
+require 'pp'
+
+require 'active_record'
+require 'active_model'
+require 'action_controller'
+require 'action_view'
+require 'action_view/base'
+require 'action_view/template'
+
+require 'simple_show'
+require 'app/helpers/simple_show/application_helper'
+
+################################################################################
+
+ActiveRecord::Base.establish_connection(:adapter => "sqlite3", :database => ":memory:")
+ActiveRecord::Migration.verbose = false
+
+ActiveRecord::Schema.define(:version => 1) do
+  create_table :golfers do |t|
+    t.column :name, :string
+    t.column :phone, :string
+    t.column :email, :string
+    t.column :born_on, :date
+    t.column :is_left_handed, :boolean
+    t.column :handicap, :decimal, :scale => 3, :precision => 1
+    t.timestamps
+  end
+end
+
+################################################################################
+
+class Golfer < ActiveRecord::Base
+end
+
+################################################################################
+
+class SimpleShowTestCase < ActiveSupport::TestCase
+  include SimpleShow::ApplicationHelper
+  include ActionController::RecordIdentifier
+  include ActionView::Helpers::CaptureHelper
+  include ActionView::Helpers::TagHelper
+  attr_accessor :output_buffer
+
+  def setup
+    @philip = Golfer.create!(
+      :name           => 'Philip Hallstrom',
+      :phone          => '3604801209',
+      :email          => 'philip@pjkh.com',
+      :born_on        => Date.civil(1974, 5, 24),
+      :is_left_handed => true,
+      :handicap       => 6.5
+    )
+  end
+end
+

data/test/test_simple_show.rb

@@ -0,0 +1,26 @@
+require 'test_helper'
+
+class SimpleShowTest < SimpleShowTestCase
+
+  test 'setup block yields self' do
+    SimpleShow.setup do |config|
+      assert_equal SimpleShow, config
+    end
+  end
+
+  test 'default configuration' do
+    assert_equal :simple_show , SimpleShow.show_class
+    assert_equal :div         , SimpleShow.wrapper_tag
+    assert_equal :show        , SimpleShow.wrapper_class
+    assert_equal :label       , SimpleShow.label_tag
+    assert_equal nil          , SimpleShow.label_class
+    assert_equal nil          , SimpleShow.label_prefix
+    assert_equal ':'          , SimpleShow.label_suffix
+    assert_equal :span        , SimpleShow.value_tag
+    assert_equal :value       , SimpleShow.value_class
+    assert_equal nil          , SimpleShow.value_prefix
+    assert_equal nil          , SimpleShow.value_suffix
+    assert_equal true         , SimpleShow.clear_on_close
+  end
+
+end

data/test/test_simple_show_for.rb

@@ -0,0 +1,40 @@
+require 'test_helper'
+
+class SimpleShowForTest < SimpleShowTestCase
+
+  test 'simple_show_for raises error without a block' do
+    assert_raise ArgumentError do
+      simple_show_for 
+    end
+  end
+
+  test 'html wrapper includes the correct id and class' do
+    doc = Nokogiri::HTML.fragment(simple_show_for @philip do |f| 
+      ''
+    end)
+    assert_equal %w[simple_show golfer], doc.at('div').attr('class').split(/\s+/)
+    assert_equal "golfer_#{@philip.id}", doc.at('div').attr('id')
+  end
+
+  test 'last tag is a BR that clears all when enabled' do
+    clear_on_close = SimpleShow::clear_on_close
+    SimpleShow::clear_on_close = true
+    doc = Nokogiri::HTML.fragment(simple_show_for @philip do |f| 
+      ''
+    end)
+    SimpleShow::clear_on_close = clear_on_close
+    assert_equal 'br', doc.at('div').elements.last.name
+    assert_equal 'all', doc.at('div').elements.last.attr('clear')
+  end
+
+  test 'last tag is not a BR when disabled' do
+    clear_on_close = SimpleShow::clear_on_close
+    SimpleShow::clear_on_close = false
+    doc = Nokogiri::HTML.fragment(simple_show_for @philip do |f| 
+      ''
+    end)
+    assert_not_equal 'br', doc.at('div').elements.last.try(:name)
+    SimpleShow::clear_on_close = clear_on_close
+  end
+
+end

data/test/test_simple_show_label.rb

@@ -0,0 +1,14 @@
+require 'test_helper'
+
+class SimpleShowLabelTest < SimpleShowTestCase
+
+  test 'labels and label overrides' do
+    doc = Nokogiri::HTML.fragment(simple_show_for @philip do |f| 
+      f.show :name
+      f.show :phone, :label => 'Cell Phone'
+    end)
+    assert_equal 'Name:', doc.css('label').first.text
+    assert_equal 'Cell Phone:', doc.css('label').last.text
+  end
+
+end

data/test/test_simple_show_value.rb

@@ -0,0 +1,16 @@
+require 'test_helper'
+
+class SimpleShowValueTest < SimpleShowTestCase
+
+  test 'values and value overrides' do
+    doc = Nokogiri::HTML.fragment(simple_show_for @philip do |f| 
+      f.show :name
+      f.show(:email) {|o| o.email.upcase }
+      f.show :phone, :value => '867-5309'
+    end)
+    assert_equal 'Philip Hallstrom', doc.css('span.value')[0].text
+    assert_equal 'PHILIP@PJKH.COM', doc.css('span.value')[1].text
+    assert_equal '867-5309', doc.css('span.value')[2].text
+  end
+
+end

metadata

@@ -0,0 +1,90 @@
+--- !ruby/object:Gem::Specification 
+name: simple_show
+version: !ruby/object:Gem::Version 
+  hash: 29
+  prerelease: 
+  segments: 
+  - 0
+  - 0
+  - 1
+  version: 0.0.1
+platform: ruby
+authors: 
+- Philip Hallstrom
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-08-01 00:00:00 -07:00
+default_executable: 
+dependencies: []
+
+description: "SimpleShow is #new what SimpleForm is to #edit"
+email: 
+- philip@pjkh.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- .gitignore
+- .rvmrc
+- Gemfile
+- README.rdoc
+- Rakefile
+- app/helpers/simple_show/application_helper.rb
+- lib/generators/simple_show/USAGE
+- lib/generators/simple_show/install_generator.rb
+- lib/generators/simple_show/templates/config/initializers/simple_show.rb
+- lib/simple_show.rb
+- lib/simple_show/base.rb
+- lib/simple_show/railtie.rb
+- lib/simple_show/version.rb
+- simple_show.gemspec
+- test/test_helper.rb
+- test/test_simple_show.rb
+- test/test_simple_show_for.rb
+- test/test_simple_show_label.rb
+- test/test_simple_show_value.rb
+has_rdoc: true
+homepage: ""
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: simple_show
+rubygems_version: 1.4.2
+signing_key: 
+specification_version: 3
+summary: "SimpleShow is #new what SimpleForm is to #edit"
+test_files: 
+- test/test_helper.rb
+- test/test_simple_show.rb
+- test/test_simple_show_for.rb
+- test/test_simple_show_label.rb
+- test/test_simple_show_value.rb