simple_display 0.0.1.alpha

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: ca2b12251ad6518748638eef041b252158550248
+  data.tar.gz: 4fa6413876069b53ca43c9c264329c24c59c2a56
+SHA512:
+  metadata.gz: 44788351ca7d6ae2b78d17a5ad434bd0bf595841a3f8126ef520cc049d2cbc713402dd9fb91e36a669f1cb156f7deca407f11e3b37b95a67bbac5ca6a8adf0cc
+  data.tar.gz: 8b044500cf8e51a91c050d91577a936d25aa634db50d33e264e8aee86d8acc7e7de21618ed666b3fd2c4235c4df80adad65de7737c609ec8cb8cfca372907ebc

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in simple_display.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Marc Riera
+
+MIT License
+
+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,65 @@
+# SimpleDisplay
+
+Showcase your Rails models easily.
+
+**SimpleDisplay** aims to provide a flexible way to display your model
+attribute and methods, so you can move from this:
+
+```erb
+<dl>
+  <% if @book.title.present? %>
+    <dt>Title</dt>
+    <dd><%= @example.title %></dd>
+  <% end %>
+
+  <% if @example.price.present? %>
+    <dt>Price</dt>
+    <dd><%= number_with_currency @example.price %></dd>
+  <% end %>
+</dl>
+```
+
+To this:
+
+```erb
+<%= display_for @example do |d| %>
+  <dl>
+    <%= d.display :title %>
+    <%= d.currency :price %>
+  </dl>
+<% end %>
+```
+
+This gem was inspired by [this
+post](http://quickleft.com/blog/drying-your-views-with-dsl-s?utm_source=rubyweekly&utm_medium=email)
+by Ben West in the Quick Left blog. Thank you! <3
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'simple_display', github: 'mrcasals/simple_display'
+
+And then execute:
+
+    $ bundle
+
+## Usage
+
+*TODO: add some content here! Meanwhile, check the introduction of the README
+file.*
+
+## TODO
+
+* Add tests & docs (sorry!)
+* Add more displayers
+* Add more content to this README file
+* Let users use custom displayers
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/lib/simple_display/action_view_extensions/display_helper.rb

@@ -0,0 +1,9 @@
+module SimpleDisplay
+  module ActionViewExtensions
+    module DisplayHelper
+      def display_for(model, &block)
+        capture(SimpleDisplay::DisplayBlock.new(model, self), &block)
+      end
+    end
+  end
+end

data/lib/simple_display/display_block.rb

@@ -0,0 +1,31 @@
+require 'active_support/inflector'
+
+module SimpleDisplay
+  class DisplayBlock
+    attr_reader :model, :helper
+
+    def initialize(model, helper)
+      @model, @helper = model, helper
+    end
+
+    def display(field, label = nil, &block)
+      base_displayer = SimpleDisplay::Displayers::Base.new(model, helper)
+      base_displayer.display(field, label, &block)
+    end
+
+    def method_missing(method, *args, &block)
+      klass = "simple_display/displayers/#{method}_displayer".camelize
+      if Module.const_get(klass).is_a?(Class)
+        klass = klass.constantize
+        klass.new(model, helper).display(*args)
+      else
+        super
+      end
+    end
+
+    def respond_to?(method, *args, &block)
+      klass = "simple_display/displayers/#{method}_displayer".camelize
+      Module.const_get(klass).is_a?(Class) || super
+    end
+  end
+end

data/lib/simple_display/displayers/base.rb

@@ -0,0 +1,37 @@
+module SimpleDisplay
+  module Displayers
+    class Base
+      attr_reader :model, :helper
+
+      def initialize(model, helper)
+        @model = model
+        @helper = helper
+      end
+
+      def display(field, label = nil, &block)
+        field_value = model.send(field)
+        if field_value.present?
+          content = value(field_value, &block)
+
+          line(disp_label(field, label), content.to_s)
+        end
+      end
+
+      private
+
+      def value(field_value, &block)
+        return helper.capture(field_value, &block) if block_given?
+        field_value
+      end
+
+      def disp_label(field, label)
+        label || model.class.human_attribute_name(field)
+      end
+
+      def line(dt, dd)
+        helper.content_tag(:dt, dt) +
+          helper.content_tag(:dd, dd)
+      end
+    end
+  end
+end

data/lib/simple_display/displayers/currency_displayer.rb

@@ -0,0 +1,12 @@
+module SimpleDisplay
+  module Displayers
+    class CurrencyDisplayer < Base
+      def display(field, label = nil, &block)
+        super(field, label) do |f|
+          currency = helper.number_to_currency value(model.send(field), &block)
+          helper.content_tag(:strong, currency)
+        end
+      end
+    end
+  end
+end

data/lib/simple_display/displayers.rb

@@ -0,0 +1,8 @@
+module SimpleDisplay
+  module Displayers
+    extend ActiveSupport::Autoload
+
+    autoload :Base
+    autoload :CurrencyDisplayer
+  end
+end

data/lib/simple_display/railtie.rb

@@ -0,0 +1,12 @@
+require 'rails/railtie'
+require 'simple_display/action_view_extensions/display_helper'
+
+module SimpleDisplay
+  class Railtie < Rails::Railtie
+    config.eager_load_namespaces << SimpleDisplay
+
+    initializer 'simple_display.action_view_extensions.display_helper' do
+      ActionView::Base.send :include, SimpleDisplay::ActionViewExtensions::DisplayHelper
+    end
+  end
+end

data/lib/simple_display/version.rb

@@ -0,0 +1,3 @@
+module SimpleDisplay
+  VERSION = "0.0.1.alpha"
+end

data/lib/simple_display.rb

@@ -0,0 +1,14 @@
+require 'simple_display/version'
+require 'action_view'
+require 'simple_display/display_block'
+require 'simple_display/action_view_extensions/display_helper'
+
+module SimpleDisplay
+  extend ActiveSupport::Autoload
+
+  eager_autoload do
+    autoload :Displayers
+  end
+end
+
+require 'simple_display/railtie' if defined?(Rails)

data/simple_display.gemspec

@@ -0,0 +1,23 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'simple_display/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "simple_display"
+  spec.version       = SimpleDisplay::VERSION
+  spec.authors       = ["Marc Riera"]
+  spec.email         = ["mrc2407@gmail.com"]
+  spec.description   = %q{Write a gem description}
+  spec.summary       = %q{Write a gem summary}
+  spec.homepage      = ""
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files`.split($/)
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.3"
+  spec.add_development_dependency "rake"
+end

metadata

@@ -0,0 +1,87 @@
+--- !ruby/object:Gem::Specification
+name: simple_display
+version: !ruby/object:Gem::Version
+  version: 0.0.1.alpha
+platform: ruby
+authors:
+- Marc Riera
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-04-25 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Write a gem description
+email:
+- mrc2407@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/simple_display.rb
+- lib/simple_display/action_view_extensions/display_helper.rb
+- lib/simple_display/display_block.rb
+- lib/simple_display/displayers.rb
+- lib/simple_display/displayers/base.rb
+- lib/simple_display/displayers/currency_displayer.rb
+- lib/simple_display/railtie.rb
+- lib/simple_display/version.rb
+- simple_display.gemspec
+homepage: ''
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>'
+    - !ruby/object:Gem::Version
+      version: 1.3.1
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.0.3
+signing_key: 
+specification_version: 4
+summary: Write a gem summary
+test_files: []
+has_rdoc: