RubyGems - rails-block-labels - Versions diffs - 0.0.1 - Mend

rails-block-labels 0.0.1

Files changed (10) hide show

data/.gitignore +12 -0
data/.rspec +1 -0
data/README.md +243 -0
data/Rakefile +23 -0
data/lib/rails-block-labels.rb +1 -0
data/lib/rails_block_labels.rb +34 -0
data/rails-block-labels.gemspec +20 -0
data/spec/rails_block_labels_spec.rb +7 -0
data/spec/spec_helper.rb +6 -0
metadata +73 -0

data/.gitignore ADDED Viewed

@@ -0,0 +1,12 @@
+*.log
+\#*
+.\#*
+build
+pkg
+tmp
+eproject.cfg
+.eproject
+*.bundle
+.DS_Store
+*.gem
+*.rbc

data/.rspec ADDED Viewed

	@@ -0,0 +1 @@
1	+ --color

data/README.md ADDED Viewed

@@ -0,0 +1,243 @@
+# Shaven - Templating without mustaches!
+Hey guys, look at present fasion... mustaches are not fashionable anymore =P.
+Take a look how nice looking are shaven templates.
+## Motivation
+I'm not a designer, usualy all templates in my work are prepared by external
+design studios or freelancers... But of course they are always pure xhtml.
+So still we have to deal with them, convert to haml, fill in with mustaches or
+erb sh**t! Now, my patience is over. Shaven will readmit some MVPC's fresh
+air to your web apps and allow you to get rid of stupid logic from your views.
+## Installation
+Installation with rubygems should go without quirks. Shaven depends on Nokogiri - if
+you don't have it installed yet then i recommend you to check out its documentation
+to avoid problems.
+    $ gem install shaven
+## How it works?
+Shaven views are splited into two layers (similar to defunk's mustache) - Template
+and Presenter. Templates are pure html files, Presenters are ruby classes
+which provides data for templates. Depending on the data type provided by
+presenter's methods you can freely and easily manipulate all contents within
+your templates. Ok, lets finish talking and take a look at examples...
+### Simple usage
+    class SimplePresenter < Shaven::Presenter
+      def title
+      	"Hello world!"
+      end
+      def description
+        "Yeah, hello beautiful code..."
+      end
+    end
+    html = <<-HTML
+    <!DOCTYPE html>
+    <html>
+    <head>
+      <title data-fill="title">Example title!</title>
+    </head>
+    <body>
+      <h1 data-fill="title">Example title</h1>
+      <p data-fill="description">Example description...</p>
+    </body>
+    </html>
+    HTML
+    SimplePresenter.feed(html).to_html
+This code produces following html:
+    <!DOCTYPE html>
+    <html>
+    <head>
+      <title>Hello World!</title>
+    </head>
+    <body>
+      <h1>Hello World!</h1>
+      <p>Yeah, hello beautiful code...</p>
+    </body>
+    </html>
+### DOM manipulation
+    class ManipulationPresenter < Shaven::Presenter
+      # If you add parameter to the presenter method, original node will
+      # passed to it. Given element is an Nokogiri::XML::Node with some
+      # extra helpers for content manipulation.
+      def login_link(node)
+        node.update!(:href => logout_path, :method => "delete")
+      end
+      # You can use extra html helpers to create new dom elements...
+      def home_page_link
+        a(:href => root_path, :class => "home-page-link") { "Go home!" }
+      end
+      # ... or to replace current.
+      def title(node)
+        node.replace! { tag(:h1, :id => "header") { "This is Sparta! "} }
+      end
+    end
+    html = <<-HTML
+    <!DOCTYPE html>
+    <html>
+    <body>
+      <div rb="title">Example title</div>
+      <a href="#" data-fill="logout_link">Logout!</a>
+      <div data-fill="home_page_link">Home page link will go here...</div>
+    </body>
+    </html>
+    HTML
+    ManipulationPresenter.feed(html).to_html
+Result:
+    <!DOCTYPE html>
+    <html>
+    <body>
+      <h1 id="header">This is Sparta!</h1>
+      <a href="/logout" data-method="delete">Logout!</a>
+      <div><a href="/" class="home-page-link">Go Home!</a></div>
+    </body>
+    </html>
+### Hash scopes and lists
+Now, the true power of Shaven. Suport for lists and scopes.
+    class ComplexPresenter < Shaven::Presenter
+      # As scopes are treaded all hashes and objects responding to `#to_shaven`
+      # method (which returns hash with attributes).
+      def user
+        { :name => "John Doe",
+          :email => "john@doe.com",
+        }
+      end
+      def users_list
+        [ { :name => tag(:strong) { "Emmet Brown" }, :email => "emmet@brown.com"},
+          { :name => proc { |node| node.update!(:class => "marty") { "Marty Macfly" }, :email => "marty@macfly.com" },
+          { :name => "Biff Tannen", :email => "biff@tannen.com" }
+        ]
+      end
+    end
+    html = <<-HTML
+    <!DOCTYPE html>
+    <html>
+    <body>
+      <h1>Single user here!</h1>
+      <div data-fill="user">
+        <h2 data-fill="name">Sample name</h2>
+        <p data-fill="email">sapmle@email.com</p>
+      </div>
+      <h1>More users</h1>
+      <ul id="users">
+        <li data-fill="users_list">
+          <span data-fill="name">Sample name</span>
+          <span data-fill="email">sample@email.com</span>
+        <li>
+      </ul>
+    </body>
+    </html>
+    HTML
+And the awesome result is:
+    <!DOCTYPE html>
+    <html>
+    <body>
+      <h1>Single user here!</h1>
+      <div data-fill="user">
+        <h2>Adam Smith</h2>
+        <p>adam@smith.com</p>
+      </div>
+      <h1>More users</h1>
+      <ul id="users">
+        <li>
+          <span><strong>Emmet Brown</strong></span>
+          <span>brown@brown.com</span>
+        <li>
+        <li class="marty">
+          <span>Marty Macfly</span>
+          <span>marty@macfly.com</span>
+        <li>
+        <li>
+          <span>Biff Tannen</span>
+          <span>biff@tannen.com</span>
+        <li>
+      </ul>
+    </body>
+    </html>
+### Conditionals
+    class ConditionalsPresenter < Shaven::Presenter
+      def true?
+        true
+      end
+      def false?
+        false
+      end
+    end
+    html = <<-HTML
+    <!DOCTYPE html>
+    <html>
+    <body>
+      <div data-if="true?">Hello...</div>
+      <div data-unless="false?">World!</div>
+    </body>
+    </html>
+    HTML
+### Dummy elements
+    html = <<-HTML
+    <!DOCTYPE html>
+    <html>
+    <body>
+      <h1>Hello dummies!</h1>
+      <div data-dummy="yes">This is dummy text!</div>
+    </body>
+    </html>
+    HTML
+produces:
+    <!DOCTYPE html>
+    <html>
+    <body>
+      <h1>Hello dummies!</h1>
+    </body>
+    </html>
+## Benchmarks
+Ruby 1.9.2
+          user     system      total        real
+    Shaven    3.480000   0.050000   3.530000 (  3.539728)
+    ERB       1.360000   0.010000   1.370000 (  1.374822)
+    Mustache  6.830000   0.080000   6.910000 (  6.904736)
+    HAML     10.800000   0.080000  10.880000 ( 10.886872)
+Ruby 1.8.7
+          user     system      total        real
+    Shaven    8.510000   0.120000   8.630000 (  8.658850)
+    ERB       1.510000   0.010000   1.520000 (  1.516075)
+    Mustache  5.230000   0.070000   5.300000 (  5.314266)
+    HAML     13.100000   0.230000  13.330000 ( 13.337038)

data/Rakefile ADDED Viewed

@@ -0,0 +1,23 @@
+# -*- ruby -*-
+begin
+  require 'rspec/core/rake_task'
+  RSpec::Core::RakeTask.new(:spec) do |t|
+    t.rspec_opts = ENV['RSPEC_OPTS']
+  end
+rescue LoadError
+  task :spec do
+    abort 'Run `gem install rspec` to install RSpec'
+  end
+end
+task :test => :spec
+task :default => :test
+require 'rake/rdoctask'
+Rake::RDocTask.new do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "Rails Block Labels"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/lib/rails-block-labels.rb ADDED Viewed

	@@ -0,0 +1 @@
1	+ require 'rails_block_labels'

data/lib/rails_block_labels.rb ADDED Viewed

@@ -0,0 +1,34 @@
+require 'rails'
+class ActionView::Helpers::InstanceTag
+  def to_label_tag(text = nil, options = {}, &block)
+    options = options.stringify_keys
+    tag_value = options.delete("value")
+    name_and_id = options.dup
+    if name_and_id["for"]
+      name_and_id["id"] = name_and_id["for"]
+    else
+      name_and_id.delete("id")
+    end
+    add_default_name_and_id_for_value(tag_value, name_and_id)
+    options.delete("index")
+    options["for"] ||= name_and_id["id"]
+    content = if text.blank?
+      method_and_value = tag_value.present? ? "#{method_name}.#{tag_value}" : method_name
+      I18n.t("helpers.label.#{object_name}.#{method_and_value}", :default => "").presence
+    else
+      text.to_s
+    end
+    content ||= if object && object.class.respond_to?(:human_attribute_name)
+      object.class.human_attribute_name(method_name)
+    end
+    content ||= method_name.humanize
+    content += capture(&block)
+    label_tag(name_and_id["id"], content.html_safe, options)
+  end
+end

data/rails-block-labels.gemspec ADDED Viewed

@@ -0,0 +1,20 @@
+# -*- ruby -*-
+$LOAD_PATH.unshift(File.expand_path('../lib', __FILE__))
+require 'shaven/version'
+Gem::Specification.new do |s|
+  s.name              = "rails-block-labels"
+  s.rubyforge_project = "RailsBlockLabels"
+  s.version           = "0.0.1"
+  s.authors           = ["Chris Kowalik"]
+  s.email             = ["chris@nu7hat.ch"]
+  s.homepage          = "http://github.com/nu7hatch/rails-block-labels"
+  s.summary           = "Hack for using i18n powered block labels in rails3 app!"
+  s.description       = "Allows to use block labels as wrappers for inputs, without loosing i18n stuff."
+  s.files             = `git ls-files`.split("\n")
+  s.test_files        = `git ls-files -- {spec}/*`.split("\n")
+  s.require_paths     = ['lib']
+  s.add_dependency 'rails', '~> 3.0'
+end

data/spec/rails_block_labels_spec.rb ADDED Viewed

@@ -0,0 +1,7 @@
+require File.dirname(__FILE__) + "/spec_helper"
+describe "Rails block labels" do
+  it "works" do
+    pending "Seems to work :P"
+  end
+end

data/spec/spec_helper.rb ADDED Viewed

@@ -0,0 +1,6 @@
+require 'rspec'
+require 'rails_block_labels'
+RSpec.configure do |conf|
+  conf.mock_with :mocha
+end

metadata ADDED Viewed

@@ -0,0 +1,73 @@
+--- !ruby/object:Gem::Specification
+name: rails-block-labels
+version: !ruby/object:Gem::Version
+  prerelease:
+  version: 0.0.1
+platform: ruby
+authors:
+- Chris Kowalik
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2011-09-30 00:00:00 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: "3.0"
+  type: :runtime
+  version_requirements: *id001
+description: Allows to use block labels as wrappers for inputs, without loosing i18n stuff.
+email:
+- chris@nu7hat.ch
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rspec
+- README.md
+- Rakefile
+- lib/rails-block-labels.rb
+- lib/rails_block_labels.rb
+- rails-block-labels.gemspec
+- spec/rails_block_labels_spec.rb
+- spec/spec_helper.rb
+homepage: http://github.com/nu7hatch/rails-block-labels
+licenses: []
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: "0"
+requirements: []
+rubyforge_project: RailsBlockLabels
+rubygems_version: 1.8.10
+signing_key:
+specification_version: 3
+summary: Hack for using i18n powered block labels in rails3 app!
+test_files: []