sinatra-decorator 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: dac99779fb490d7e38e0d6865bc666ae9e195497
+  data.tar.gz: a2ab9a7aedc6a84d3f21fdc90f193822b25633f9
+SHA512:
+  metadata.gz: c0217bed1404b42db04b327bd16df42efbbdb0cc4437f4e4b1d8aa1543a7bae493012b3cb91c441c0d6a951946f30a8dc73bfd9624e12eeefd88414524eb8cf6
+  data.tar.gz: b436860c01bd959f205427b471fd043f0c200baab6c66aa03b9f3dadc0a03e7b808f8591b9dd89ba79718260472e93f462f98db2f7249e411ff8841fea4eecbc

data/.document

@@ -0,0 +1,4 @@
+lib/**/*.rb
+-
+README.md
+LICENSE

data/.gitignore

@@ -0,0 +1,9 @@
+Gemfile.lock
+.bundle
+.yardoc
+*.rbc
+.rbx/
+doc/
+.DS_Store
+tags
+pkg/*

data/.travis.yml

@@ -0,0 +1,17 @@
+lang: ruby
+before_install: gem install bundler --pre
+install:
+  - gem update --system
+  - bundle update
+rvm:
+  - 1.9.3
+  - 2.0.0
+  - 2.1.0
+  - rbx
+  - jruby-19mode
+branches:
+  only:
+    - master
+matrix:
+  allow_failures:
+    - rvm: rbx

data/.yardopts

@@ -0,0 +1,7 @@
+--title 'Sinatra Decorator Documentation'
+--charset utf-8
+--protected
+--markup-provider=redcarpet
+--markup=markdown
+--exclude lib/sinatra-decorator/generators/components
+lib/**/*.rb

data/Gemfile

@@ -0,0 +1,23 @@
+source 'https://rubygems.org'
+
+gemspec
+gem 'rake'
+
+group :development, :test do
+  gem 'coveralls', :require => false
+  gem 'pry'
+  gem 'pry-nav'
+end
+
+group :test do
+  gem 'rack-test',  '>= 0.5.0'
+  gem 'minitest',   '~> 4.0'
+  gem 'mocha',      '>= 0.10.0'
+  gem 'turn'
+end
+
+group :development do
+  gem 'yard',       '>= 0.7.2'
+  gem 'kramdown'
+  gem 'github-markup'
+end

data/LICENSE

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Naotoshi Seo
+
+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,82 @@
+# Sinatra Decorator
+
+sinatra-decorator is a gem for [Sinatra](http://www.sinatrarb.com/).  
+Adds an object-oriented layer of presentation logic to your Sinatra application.
+
+[![Build Status](https://travis-ci.org/sonots/sinatra-decorator.svg)](https://travis-ci.org/sonots/sinatra-decorator)
+[![Code Climate](https://codeclimate.com/github/sonots/sinatra-decorator.png)](https://codeclimate.com/github/sonots/sinatra-decorator)
+[![Coverage Status](https://coveralls.io/repos/sonots/sinatra-decorator/badge.png)](https://coveralls.io/r/sonots/sinatra-decorator)
+[![Dependency Status](https://gemnasium.com/sonots/sinatra-decorator.png)](https://gemnasium.com/sonots/sinatra-decorator)
+
+## Installation
+
+Add the following to your `Gemfile`:
+
+```ruby
+gem 'sinatra-decorator'
+```
+
+And then execute:
+
+```plain
+$ bundle
+```
+
+## Examples
+
+```ruby
+# app.rb
+require 'sinatra'
+require 'slim'
+require 'sinatra-decorator'
+require_relative 'models/post'
+require_relative 'decorators/post_decorator'
+
+get '/' do
+  @post = Post.new.decorate
+  slim :show
+end
+
+# models/post.rb
+#class Post < ActiveRecord::Base
+#  include Sinatra::Decorator::Decoratable
+#end
+class Post
+  include Sinatra::Decorator::Decoratable
+
+  attr_accessor :id, :body
+  def initialize(params = {})
+    @id   = params[:id]   || 1
+    @body = params[:body] || "body"
+  end
+end
+
+# decorators/post_decorator.rb
+class PostDecorator < Sinatra::Decorator::Base
+  def formated_body
+    object.body.gsub('b', 'a')
+  end
+end
+
+# views/show.slim
+h1 = @post.id
+div
+  = @post.formated_body
+```
+
+## 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
+
+## Copyright
+
+Copyright (c) 2014 Naotoshi Seo. See [LICENSE](LICENSE) for details.
+
+## Special Thanks
+
+This gem was made on the basis of the [padrino-decorator](https://github.com/tyabe/padrino-decorator). 
+I greatly appreciate for the orignal author Mr. [@tyabe](https://github.com/tyabe).

data/Rakefile

@@ -0,0 +1,25 @@
+# coding: utf-8
+require 'rubygems'  unless defined?(Gem)
+require 'rake'
+require 'rake/testtask'
+require 'yard'
+require 'bundler/gem_tasks'
+Rake::TestTask.new(:test) do |test|
+  test.libs << 'test'
+  test.test_files = Dir['test/**/test_*.rb']
+  test.verbose = true
+end
+
+desc 'Run tests for all'
+task :default => :test
+
+desc 'Generate documentation for the Sinatra decorator'
+task :doc do
+  YARD::CLI::Yardoc.new.run
+end
+
+desc 'Open an irb session preloaded with the gem library'
+task :console do
+  sh 'irb -rubygems -I lib -r sintra-decorator'
+end
+task :c => :console

data/example/Gemfile

@@ -0,0 +1,6 @@
+# encoding: utf-8
+source 'https://rubygems.org'
+
+gem 'sinatra'
+gem 'slim'
+gem 'sinatra-decorator', path: '../'

data/example/app.rb

@@ -0,0 +1,11 @@
+# my_app.rb
+require 'sinatra'
+require 'slim'
+require 'sinatra-decorator'
+require_relative 'models/post'
+require_relative 'decorators/post_decorator'
+
+get '/' do
+  @post = Post.new.decorate
+  slim :show
+end

data/example/decorators/post_decorator.rb

@@ -0,0 +1,5 @@
+class PostDecorator < Sinatra::Decorator::Base
+  def formated_body
+    object.body.gsub('b', 'a')
+  end
+end

data/example/models/post.rb

@@ -0,0 +1,12 @@
+#class Post < ActiveRecord::Base
+#  include Sinatra::Decorator::Decoratable
+#end
+class Post
+  include Sinatra::Decorator::Decoratable
+
+  attr_accessor :id, :body
+  def initialize(params = {})
+    @id   = params[:id]   || 1
+    @body = params[:body] || "body"
+  end
+end

data/example/views/show.slim

@@ -0,0 +1,3 @@
+h1 = @post.id
+div
+  = @post.formated_body

data/lib/sinatra-decorator/base.rb

@@ -0,0 +1,48 @@
+require 'delegate'
+module Sinatra
+  module Decorator
+    class Base < SimpleDelegator
+
+      attr_reader :object
+
+      def initialize(object, options = {})
+        @object = object
+        @context = options[:context]
+        super(object)
+      end
+
+      def to_model
+        __getobj__
+      end
+
+      def class
+        to_model.class
+      end
+
+      def kind_of?(klass)
+        to_model.kind_of?(klass)
+      end
+      alias_method :is_a?, :kind_of?
+
+      def instance_of?(klass)
+        to_model.instance_of?(klass)
+      end
+
+      def decorated?
+        true
+      end
+
+      private
+
+      def self.context(context)
+        _helper_method_name = :h
+        define_method(_helper_method_name) do
+          @context || context.to_s.camelize.constantize.new!
+        end
+        private _helper_method_name
+      end
+
+    end # Base
+
+  end # Decorator
+end # Sinatra

data/lib/sinatra-decorator/decoratable.rb

@@ -0,0 +1,17 @@
+module Sinatra
+  module Decorator
+    module Decoratable
+      def decorate(options = {})
+
+        klass = options[:as]
+        klass_name = "#{self.class}Decorator"
+        klass = klass_name.constantize if klass.nil?
+        decorator = klass.new(self, context: self)
+
+        yield decorator if block_given?
+        decorator
+      end
+    end # Decoratable
+  end # Decorator
+end # Sinatra
+

data/lib/sinatra-decorator/decorate_helpers.rb

@@ -0,0 +1,26 @@
+module Sinatra
+  module Decorator
+
+    module DecorateHelpers
+      def decorate(object, options = {})
+
+        klass = options[:as]
+
+        if object.respond_to?(:first)
+          return [] if object.empty?
+          klass_name = "#{object.first.class}Decorator"
+          klass = klass_name.constantize if klass.nil?
+          decorator = object.map{|o| klass.new(o, context: self)}
+        else
+          klass_name = "#{object.class}Decorator"
+          klass = klass_name.constantize if klass.nil?
+          decorator = klass.new(object, context: self)
+        end
+
+        yield decorator if block_given?
+        decorator
+      end
+    end # DecorateHelpers
+
+  end # Decorator
+end # Sinatra

data/lib/sinatra-decorator/version.rb

@@ -0,0 +1,9 @@
+module Sinatra
+  module Decorator
+    VERSION = '0.0.1' unless defined?(Sinatra::Decorator::VERSION)
+
+    def self.version
+      VERSION
+    end
+  end
+end

data/lib/sinatra-decorator.rb

@@ -0,0 +1,6 @@
+require 'active_support/core_ext'
+require 'sinatra-decorator/version'
+require 'sinatra-decorator/base'
+require 'sinatra-decorator/decoratable'
+require 'sinatra-decorator/decorate_helpers'
+

data/sinatra-decorator.gemspec

@@ -0,0 +1,26 @@
+#!/usr/bin/env gem build
+# encoding: utf-8
+
+require File.expand_path('../lib/sinatra-decorator/version', __FILE__)
+
+Gem::Specification.new do |s|
+  s.name          = "sinatra-decorator"
+  s.rubyforge_project = "sinatra-decorator"
+  s.authors       = ["Naotoshi Seo"]
+  s.email         = ["sonots@gmail.com"]
+  s.summary       = "View models for sinatra"
+  s.homepage      = "https://github.com/sonots/sinatra-decorator#readme"
+  s.description   = "Object-Oriented layer of presentation logic to your Sinatra apps."
+  s.required_rubygems_version = ">= 1.3.6"
+  s.version       = Sinatra::Decorator.version
+  s.date          = Time.now.strftime("%Y-%m-%d")
+
+  s.extra_rdoc_files = Dir["*.rdoc"]
+  s.files         = `git ls-files`.split($\)
+  s.test_files    = s.files.grep(%r{^(test|spec|features)/})
+  s.executables   = s.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  s.require_paths = ["lib"]
+  s.rdoc_options  = ["--charset=UTF-8"]
+  
+  s.add_runtime_dependency "activesupport"
+end

data/test/helpers/helper.rb

@@ -0,0 +1,17 @@
+ENV['RACK_ENV'] = 'test'
+APP_ROOT = File.dirname(__FILE__)
+
+$: << File.expand_path(File.join(File.dirname(__FILE__), '..', '..','lib'))
+require 'rack/test'
+require File.expand_path("#{File.dirname(__FILE__)}/mini_shoulda")
+require 'sinatra-decorator'
+require 'turn'
+
+class MiniTest::Spec
+  include Rack::Test::Methods
+end
+
+if ENV['TRAVIS']
+  require 'coveralls'
+  Coveralls.wear!
+end

data/test/helpers/mini_shoulda.rb

@@ -0,0 +1,44 @@
+gem 'minitest'
+require 'minitest/autorun'
+require 'minitest/spec'
+
+begin
+  require 'ruby-debug'
+rescue LoadError; end
+
+class MiniTest::Spec
+  class << self
+    alias :setup :before unless defined?(Rails)
+    alias :teardown :after unless defined?(Rails)
+    alias :should :it
+    alias :context :describe
+    def should_eventually(desc)
+      it("should eventually #{desc}") { skip("Should eventually #{desc}") }
+    end
+  end
+  alias :assert_no_match  :refute_match
+  alias :assert_not_nil   :refute_nil
+  alias :assert_not_equal :refute_equal
+end
+
+class ColoredIO
+  def initialize(io)
+    @io = io
+  end
+
+  def print(o)
+    case o
+    when "." then @io.send(:print, o.green)
+    when "E" then @io.send(:print, o.red)
+    when "F" then @io.send(:print, o.yellow)
+    when "S" then @io.send(:print, o.magenta)
+    else @io.send(:print, o)
+    end
+  end
+
+  def puts(*o)
+    super
+  end
+end
+
+MiniTest::Unit.output = ColoredIO.new(MiniTest::Unit.output)

data/test/test_base.rb

@@ -0,0 +1,19 @@
+require File.expand_path("#{File.dirname(__FILE__)}/helpers/helper")
+
+describe Sinatra::Decorator::Base do
+  let(:decorator_class) { Class.new(Sinatra::Decorator::Base) }
+  let(:model)           { Object.new }
+
+  describe "#initialize" do
+    subject { decorator_class.new(model) }
+
+    it 'Reports its type as if it was the original object' do
+      subject.class.must_equal model.class
+      subject.must_be_kind_of  model.class
+      assert subject.kind_of?(model.class),     "The subject class (#{subject.class}) is not kind_of? the model class (#{model.class})."
+      assert subject.is_a?(model.class),        "The subject class (#{subject.class}) is not is_a? the model class (#{model.class})."
+      assert subject.instance_of?(model.class), "The subject class (#{subject.class}) is not an instance_of? the model class (#{model.class})."
+    end
+  end
+
+end

data/test/test_decoratable.rb

@@ -0,0 +1,31 @@
+require File.expand_path("#{File.dirname(__FILE__)}/helpers/helper")
+
+describe Sinatra::Decorator::Decoratable do
+
+  class User
+    include Sinatra::Decorator::Decoratable
+    attr_accessor :username, :full_name
+    def initialize(attributes = {})
+      attributes.each do |name, value|
+        send("#{name}=", value) rescue nil
+      end
+    end
+  end
+
+  class UserDecorator < Sinatra::Decorator::Base
+    def name
+      object.full_name.present? ? object.full_name : object.username
+    end
+  end
+
+  describe '.decorate' do
+    let(:dorothy) { User.new(username: 'Dorothy', full_name: 'Dorothy Gale') }
+    let(:toto)    { User.new(username: 'Toto') }
+
+    it 'Possible to decorate the single object' do
+      assert_equal dorothy.decorate.name, dorothy.full_name
+    end
+  end
+
+end
+

data/test/test_decorate_helpers.rb

@@ -0,0 +1,37 @@
+require File.expand_path("#{File.dirname(__FILE__)}/helpers/helper")
+
+describe Sinatra::Decorator::DecorateHelpers do
+
+  class User
+    attr_accessor :username, :full_name
+    def initialize(attributes = {})
+      attributes.each do |name, value|
+        send("#{name}=", value) rescue nil
+      end
+    end
+  end
+
+  class UserDecorator < Sinatra::Decorator::Base
+    def name
+      object.full_name.present? ? object.full_name : object.username
+    end
+  end
+
+  include Sinatra::Decorator::DecorateHelpers
+
+  describe '.decorate' do
+    let(:dorothy) { User.new(username: 'Dorothy', full_name: 'Dorothy Gale') }
+    let(:toto)    { User.new(username: 'Toto') }
+
+    it 'Possible to decorate the single object' do
+      assert_equal decorate(dorothy).name, dorothy.full_name
+    end
+    it 'Possible to decorate the collections' do
+      users = []
+      users << dorothy
+      users << toto
+      assert_equal decorate(users).first.name, dorothy.full_name
+    end
+  end
+
+end

metadata

@@ -0,0 +1,88 @@
+--- !ruby/object:Gem::Specification
+name: sinatra-decorator
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Naotoshi Seo
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-03-27 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Object-Oriented layer of presentation logic to your Sinatra apps.
+email:
+- sonots@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .document
+- .gitignore
+- .travis.yml
+- .yardopts
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- example/Gemfile
+- example/app.rb
+- example/decorators/post_decorator.rb
+- example/models/post.rb
+- example/views/show.slim
+- lib/sinatra-decorator.rb
+- lib/sinatra-decorator/base.rb
+- lib/sinatra-decorator/decoratable.rb
+- lib/sinatra-decorator/decorate_helpers.rb
+- lib/sinatra-decorator/version.rb
+- sinatra-decorator.gemspec
+- test/helpers/helper.rb
+- test/helpers/mini_shoulda.rb
+- test/test_base.rb
+- test/test_decoratable.rb
+- test/test_decorate_helpers.rb
+homepage: https://github.com/sonots/sinatra-decorator#readme
+licenses: []
+metadata: {}
+post_install_message: 
+rdoc_options:
+- --charset=UTF-8
+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.6
+requirements: []
+rubyforge_project: sinatra-decorator
+rubygems_version: 2.0.3
+signing_key: 
+specification_version: 4
+summary: View models for sinatra
+test_files:
+- test/helpers/helper.rb
+- test/helpers/mini_shoulda.rb
+- test/test_base.rb
+- test/test_decoratable.rb
+- test/test_decorate_helpers.rb
+has_rdoc: