netzke-draper 0.0.1

data/.gitignore

@@ -0,0 +1,6 @@
+*.gem
+Gemfile.lock
+.bundle
+pkg/
+*sublime*
+.yardoc/

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--format documentation

data/Gemfile

@@ -0,0 +1,6 @@
+source "http://rubygems.org"
+
+gemspec
+
+gem 'netzke-core',     :github => 'nomadcoder/netzke-core'
+gem 'netzke-basepack', :github => 'nomadcoder/netzke-basepack'

data/LICENSE.txt

@@ -0,0 +1,20 @@
+Copyright (c) 2012 Georg Meyer
+
+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,95 @@
+# netzke-draper [<img src="https://secure.travis-ci.org/scho/netzke-draper.png" />](http://travis-ci.org/scho/netzke-draper)
+
+netzke-draper is a simple extension for all [netzke](http://netzke.org/) components, that use the [data accessor](https://github.com/nomadcoder/netzke-basepack/blob/master/lib/netzke/basepack/data_accessor.rb) module (e.g. GridPanel). It automatically decorates your record(s) with a given decorator or one that matches the default naming convention.
+
+## Installation
+
+In Rails 3 add this to your gem file and run the ```bundle``` command.
+
+```
+gem 'netzke-draper'
+```
+
+## Usage
+
+Simply set the class of your decorator of choice in the netzke configure method.
+
+## Example
+
+Given the following grid panel:
+
+```ruby
+class BooksGridPanel < Netzke::Basepack::GridPanel
+
+  def configure(c)
+    c.model = 'Book'
+    c.decorator = 'BookDecorator'
+  end
+
+end
+```
+
+and a decorator class for your book model:
+
+```ruby
+class BookDecorator < Draper::Base
+
+  decorates :book
+
+  def funky_title
+    "#{title} - BOOM!"
+  end
+
+end
+```
+
+Now you can use all decorator methods (in this case ```funky_title```) in your column definitions of the grid panel, since it automatically wraps all records with your decorator: 
+
+```ruby
+class BooksGridPanel < Netzke::Basepack::GridPanel
+
+  # [...]
+
+  column :funky_title do |c|
+    c.text = "Funky Title"
+  end
+end
+```
+
+### Which decorator will be used?
+
+1. If you define a decorator in your config, that one will be used:
+
+  ```ruby
+  def configure(c)
+      c.decorator = 'YourDecorator'
+  end
+  ```
+
+2. If no decorator is defined, it will try to gues your decorator's class by appending 'Decorator' to your model class.
+
+3. If you set ```c.decorator``` to false, it won't decorate anything, even if a guess would be successful.
+
+4. You can also disable the default usage of a decorator with an initializer. In this case, only if there is an explicit definition of a decorator in the configuration, it will decorate your records:
+
+  ```ruby
+  # config/initializers/netzke-draper.rb
+  Netzke::Draper.configure do |config|
+      config.decorate_by_default = false
+  end
+  ```
+
+## Contributing to netzke-draper
+ 
+* 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) 2012 Georg Meyer. See LICENSE.txt for
+further details.

data/Rakefile

@@ -0,0 +1,13 @@
+require 'rubygems'
+require 'rake'
+require 'rspec/core/rake_task'
+require 'bundler'
+
+Bundler::GemHelper.install_tasks
+
+desc "Run RSpec"
+RSpec::Core::RakeTask.new do |t|
+  t.verbose = false
+end
+
+task :default => :spec

data/init.rb

@@ -0,0 +1 @@
+require 'netzke/draper'

data/lib/netzke-draper.rb

@@ -0,0 +1 @@
+require 'netzke/draper'

data/lib/netzke/draper.rb

@@ -0,0 +1,21 @@
+require 'netzke/basepack/data_accessor'
+require 'netzke/basepack/data_adapters/abstract_adapter'
+require 'netzke/basepack/data_adapters/active_record_adapter'
+
+require 'netzke/draper/configuration'
+require 'netzke/draper/basepack_ext/data_accessor'
+require 'netzke/draper/basepack_ext/data_adapters/abstract_adapter'
+require 'netzke/draper/basepack_ext/data_adapters/active_record_adapter'
+
+module Netzke
+  module Draper
+
+    class << self
+
+      def configure(&block)
+        Netzke::Draper::Configuration.configure(&block)
+      end
+
+    end
+  end
+end

data/lib/netzke/draper/basepack_ext/data_accessor.rb

@@ -0,0 +1,35 @@
+module Netzke
+  module Basepack
+    module DataAccessor
+
+      def data_adapter
+        @data_adapter ||= data_class && Netzke::Basepack::DataAdapters::AbstractAdapter.adapter_class(data_class).new(data_class, decorator_class)
+      end
+
+      # Retrieves the decorator class depending on configuration
+      # and model class
+      #
+      # @return [Class, FalseClass]
+      def decorator_class
+        if @decorator_class.nil?
+          @decorator_class ||= if config[:decorator].is_a?(String)
+            config[:decorator].constantize
+          elsif config[:decorator].is_a?(Class)
+            config[:decorator]
+          elsif config.has_key?(:decorator)
+            false
+          elsif Netzke::Draper::Configuration.decorate_by_default
+            begin
+              "#{data_class}Decorator".constantize
+            rescue NameError
+              false
+            end
+          else
+            false
+          end
+        end
+        @decorator_class
+      end
+    end
+  end
+end

data/lib/netzke/draper/basepack_ext/data_adapters/abstract_adapter.rb

@@ -0,0 +1,40 @@
+module Netzke::Basepack::DataAdapters
+  class AbstractAdapter
+
+    # Decorates the record retrieved by first
+    def first_with_decoration
+      decorate(first_without_decoration)
+    end
+    alias_method_chain :first, :decoration
+
+    # Decorates the record retrieved by find_record
+    def find_record_with_decoration(id)
+      decorate(find_record_without_decoration(id))
+    end
+    alias_method_chain :find_record, :decoration
+
+    # Decorates the record retrieved by new_record
+    def new_record_with_decoration(params = {})
+      decorate(new_record_without_decoration(params))
+    end
+    alias_method_chain :new_record, :decoration
+
+    # Override initializer to accept decorator_class
+    def initialize(model_class, decorator_class)
+      @model_class = model_class
+      @decorator_class = decorator_class
+    end
+
+    private
+
+      # Decorates record(s) if decorator_class is set
+      def decorate(record)
+        if @decorator_class
+          @decorator_class.decorate(record)
+        else
+          record
+        end
+      end
+
+  end
+end

data/lib/netzke/draper/basepack_ext/data_adapters/active_record_adapter.rb

@@ -0,0 +1,17 @@
+module Netzke::Basepack::DataAdapters
+  class ActiveRecordAdapter
+
+    # Decorates the records retrieved by get_records
+    def get_records_with_decoration(params, columns=[])
+      decorate(get_records_without_decoration(params, columns))
+    end
+    alias_method_chain :get_records, :decoration
+
+    # Decorates the records retrieved by find_record
+    def find_record_with_decoration(id)
+      decorate(find_record_without_decoration(id))
+    end
+    alias_method_chain :find_record, :decoration
+
+  end
+end

data/lib/netzke/draper/configuration.rb

@@ -0,0 +1,28 @@
+module Netzke
+  module Draper
+    module Configuration
+
+      def self.reset_config
+        configure do |config|
+          config.decorate_by_default = true
+        end
+      end
+
+      def self.configure
+        yield self
+      end
+
+      def self.decorate_by_default
+        @decorate_by_default
+      end
+
+      def self.decorate_by_default=(value)
+        @decorate_by_default = value
+      end
+
+    end
+  end
+end
+
+# Set default values
+Netzke::Draper::Configuration.reset_config

data/lib/netzke/draper/version.rb

@@ -0,0 +1,11 @@
+module Netzke
+  module Draper
+    module Version
+      MAJOR = 0
+      MINOR = 0
+      PATCH = 1
+
+      STRING = [MAJOR, MINOR, PATCH].compact.join('.')
+    end
+  end
+end

data/netzke-draper.gemspec

@@ -0,0 +1,28 @@
+
+$LOAD_PATH.unshift File.expand_path("../lib", __FILE__)
+require "netzke/draper/version"
+
+Gem::Specification.new do |s|
+  s.name        = "netzke-draper"
+  s.version     = Netzke::Draper::Version::STRING
+  s.platform    = Gem::Platform::RUBY
+  s.author      = "Georg Meyer"
+  s.email       = "georgmeyer83@googlemail.com"
+  s.homepage    = "http://github.com/scho/netzke-draper"
+  s.summary     = "Enables draper decorators in Netzke components"
+  s.description = "Gives you the ability to use any decorator in netzke components with almost no effort"
+
+  s.files        = `git ls-files`.split("\n")
+  s.test_files   = `git ls-files -- {spec}/*`.split("\n")
+  s.require_path = ["lib"]
+
+  s.add_development_dependency 'rspec', '~> 2.6.0'
+  s.add_development_dependency 'rake', '~> 0.9'
+  s.add_development_dependency 'rails', '~> 3.2.8'
+  s.add_development_dependency 'rspec-rails', '~> 2.6.1'
+
+  s.add_runtime_dependency 'draper'
+  s.add_runtime_dependency 'netzke-basepack'
+
+  s.required_rubygems_version = ">= 1.3.4"
+end

data/spec/netzke/draper/basepack_ext/data_accessor_spec.rb

@@ -0,0 +1,40 @@
+require 'spec_helper'
+
+describe Netzke::Basepack::DataAccessor do
+  describe "#decorator_class" do
+
+    before(:each) do
+      Netzke::Draper::Configuration.reset_config
+    end
+
+    it "by convention" do
+      c = DecoratedComponent.new
+      c.decorator_class.should == BookDecorator
+    end
+
+    it "by string" do
+      c = StringDecoratorComponent.new
+      c.decorator_class.should == NovelDecorator
+    end
+
+    it "by class" do
+      c = ClassDecoratorComponent.new
+      c.decorator_class.should == NovelDecorator
+    end
+
+    it "not set" do
+      c = UndecoratedComponent.new
+      c.decorator_class.should be_false
+    end
+
+    it "not set by config" do
+      Netzke::Draper.configure do |config|
+        config.decorate_by_default = false
+      end
+
+      c = DecoratedComponent.new
+      c.decorator_class.should be_false
+    end
+
+  end
+end

data/spec/netzke/draper/basepack_ext/data_adapters/abstract_adapter_spec.rb

@@ -0,0 +1,47 @@
+require 'spec_helper'
+
+describe Netzke::Basepack::DataAdapters::AbstractAdapter do
+  before(:each) do
+    Netzke::Draper::Configuration.reset_config
+    @decorated_component = DecoratedComponent.new
+    @undecorated_component = UndecoratedComponent.new
+  end
+
+  describe "#find_record" do
+    before(:each) do
+      Book.stub_chain(:where, :first).and_return(Book.new)
+    end
+
+    it "decorated component" do
+      @decorated_component.data_adapter.find_record(1).should be_a(BookDecorator)
+    end
+
+    it "undecorated component" do
+      @undecorated_component.data_adapter.find_record(1).should be_a(Book)
+    end
+  end
+
+  describe "#new_record" do
+    it "decorated component" do
+      @decorated_component.data_adapter.new_record.should be_a(BookDecorator)
+    end
+
+    it "undecorated component" do
+      @undecorated_component.data_adapter.new_record.should be_a(Book)
+    end
+  end
+
+  describe "#first" do
+    before(:each) do
+      Book.stub(:first).and_return(Book.new)
+    end
+
+    it "decorated component" do
+      @decorated_component.data_adapter.first.should be_a(BookDecorator)
+    end
+
+    it "undecorated component" do
+      @undecorated_component.data_adapter.first.should be_a(Book)
+    end
+  end
+end

data/spec/netzke/draper/basepack_ext/data_adapters/active_record_adapter_spec.rb

@@ -0,0 +1,44 @@
+require 'spec_helper'
+
+describe Netzke::Basepack::DataAdapters::ActiveRecordAdapter do
+  before(:each) do
+    Netzke::Draper::Configuration.reset_config
+    @decorated_component = DecoratedComponent.new
+    @undecorated_component = UndecoratedComponent.new
+  end
+
+  describe "#get_records" do
+    before(:each) do
+      @decorated_component.data_adapter.stub_chain(:get_relation, :all).and_return([Book.new])
+    end
+
+    describe "decorated component" do
+      it "decorates collection" do
+        @decorated_component.data_adapter.get_records({}).should be_a(Draper::DecoratedEnumerableProxy)
+      end
+
+      it "decorates elements" do
+        @decorated_component.data_adapter.get_records({}).each do |element|
+          element.should be_a(BookDecorator)
+        end
+      end
+    end
+
+    describe "undecorated component" do
+      before(:each) do
+        @undecorated_component.data_adapter.stub_chain(:get_relation, :all).and_return([Book.new])
+      end
+
+      it "doesn't decorate collection" do
+        @undecorated_component.data_adapter.get_records({}).should_not be_a(Draper::DecoratedEnumerableProxy)
+      end
+
+      it "doesn't decorate elements" do
+        @undecorated_component.data_adapter.get_records({}).each do |element|
+          element.should be_a(Book)
+        end
+      end
+    end
+  end
+
+end

data/spec/spec_helper.rb

@@ -0,0 +1,67 @@
+require 'rubygems'
+require 'rails'
+require 'active_record'
+require 'netzke-basepack'
+require 'draper'
+require 'bundler/setup'
+require 'netzke-draper'
+Bundler.require(:default)
+
+require 'active_support/all'
+
+RSpec.configure do |config|
+  config.treat_symbols_as_metadata_keys_with_true_values = true
+  config.filter_run :focus => true
+  config.run_all_when_everything_filtered = true
+  config.mock_with :rspec
+end
+
+class Book < ActiveRecord::Base
+  def self.columns
+    []
+  end
+
+  def self.primary_key
+    :id
+  end
+end
+
+class BookDecorator < Draper::Base
+  decorates :book
+end
+
+class NovelDecorator < Draper::Base
+  decorates :book
+end
+
+class DataAccessorComponent < Netzke::Base
+  include Netzke::Basepack::DataAccessor
+
+  def configure(c)
+    c.model = 'Book'
+  end
+end
+
+class DecoratedComponent < DataAccessorComponent
+end
+
+class StringDecoratorComponent < DataAccessorComponent
+  def configure(c)
+    super
+    c.decorator = 'NovelDecorator'
+  end
+end
+
+class ClassDecoratorComponent < DataAccessorComponent
+  def configure(c)
+    super
+    c.decorator = NovelDecorator
+  end
+end
+
+class UndecoratedComponent < DataAccessorComponent
+  def configure(c)
+    super
+    c.decorator = false
+  end
+end

metadata

@@ -0,0 +1,163 @@
+--- !ruby/object:Gem::Specification
+name: netzke-draper
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Georg Meyer
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-10-23 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.6.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.6.0
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.9'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.9'
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 3.2.8
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 3.2.8
+- !ruby/object:Gem::Dependency
+  name: rspec-rails
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.6.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.6.1
+- !ruby/object:Gem::Dependency
+  name: draper
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: netzke-basepack
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Gives you the ability to use any decorator in netzke components with
+  almost no effort
+email: georgmeyer83@googlemail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rspec
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- init.rb
+- lib/netzke-draper.rb
+- lib/netzke/draper.rb
+- lib/netzke/draper/basepack_ext/data_accessor.rb
+- lib/netzke/draper/basepack_ext/data_adapters/abstract_adapter.rb
+- lib/netzke/draper/basepack_ext/data_adapters/active_record_adapter.rb
+- lib/netzke/draper/configuration.rb
+- lib/netzke/draper/version.rb
+- netzke-draper.gemspec
+- spec/netzke/draper/basepack_ext/data_accessor_spec.rb
+- spec/netzke/draper/basepack_ext/data_adapters/abstract_adapter_spec.rb
+- spec/netzke/draper/basepack_ext/data_adapters/active_record_adapter_spec.rb
+- spec/spec_helper.rb
+homepage: http://github.com/scho/netzke-draper
+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'
+      segments:
+      - 0
+      hash: 766367901
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: 1.3.4
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.24
+signing_key: 
+specification_version: 3
+summary: Enables draper decorators in Netzke components
+test_files: []