characterize 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 10c960deb342856cf94ab657c4ba6836ff586e04
+  data.tar.gz: 7d64cdc96d3994ea7d8ef8cb29d3f38c5c791030
+SHA512:
+  metadata.gz: ecaf97dbfeb7db99663c858993b89c62c3eb2c29eaa1e4866c4626fbe11fc2083fc11ef654f8bc474e115f0c53f2d8aae5a40f8005368efc320d3d2e5b851370
+  data.tar.gz: 8981402f20455d18a3d44a1f0654384520b650eac8a09179510e1dbda9131cc2c1f467b2ebe45b941ef51329d2ec44c3a323d01ff46b91a2cc47f61e47549bee

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/.ruby-version

@@ -0,0 +1 @@
+2.1.0

data/Gemfile

@@ -0,0 +1,8 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in characterize.gemspec
+gemspec
+
+group :test do
+  gem 'minitest'
+end

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 'Jim Gay'
+
+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,61 @@
+# Characterize
+
+Make your models behave in special ways.
+
+## Usage
+
+```ruby
+class UsersController < ApplicationController
+  characterize :user
+
+  def show
+  end
+end
+# the above sets a helper_method of 'user' and loads UserCharacter
+
+class UsersController < ApplicationController
+  def show
+    characterize(user, display_module)
+  end
+
+  def display_module
+    current_user.can_edit?(user) ? AdministratedUser : StandardUser
+  end
+end
+
+# use a standard interface in your views but change the character of the object
+
+module AdministratedUser
+  def edit_link
+    view.link_to('Edit', admin_user_path)
+  end
+end
+
+module StandardUser
+  def edit_link
+    ""
+  end
+end
+```
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'characterize'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install characterize
+
+## 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/characterize.gemspec

@@ -0,0 +1,25 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'characterize/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "characterize"
+  spec.version       = Characterize::VERSION
+  spec.authors       = ["'Jim Gay'"]
+  spec.email         = ["jim@saturnflyer.com"]
+  spec.description   = %q{Use plain modules like presenters}
+  spec.summary       = %q{Use plain modules like presenters}
+  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_dependency "casting", "~> 0.6.8"
+
+  spec.add_development_dependency "bundler", "~> 1.3"
+  spec.add_development_dependency "rake"
+end

data/lib/characterize/controller.rb

@@ -0,0 +1,73 @@
+require 'characterize/feature_controls'
+
+module Characterize
+  module Controller
+    def self.included(klass)
+      klass.extend(::Characterize::ControllerMacros)
+    end
+    
+    private
+    def characterize(obj, *mods)
+      obj.__set_view__(view_context).cast_as(*mods)
+      obj
+    end
+  end
+  
+  module ControllerMacros
+    
+    private
+    
+    def characterize(*symbols_strings_or_classes)
+      options = symbols_strings_or_classes.empty? ? [self] : symbols_strings_or_classes
+      options.map do |identifier|
+        characterize_item = Converter.new(identifier)
+        object_name = characterize_item.to_object_name
+        mod = Module.new
+        mod.module_eval %{
+          def #{object_name}
+            @#{object_name} ||= characterize(load_#{object_name}, *characterize_#{object_name}_modules)
+          end
+          
+          def load_#{object_name}
+            #{characterize_item.to_constant_name}.find(params[:id])
+          end
+          
+          def characterize_#{object_name}_modules
+            [::Characterize::FeatureControls] + #{object_name}_modules
+          end
+          
+          def #{object_name}_modules
+            [#{object_name}_default_character]
+          end
+          
+          def #{object_name}_default_character
+            #{Converter.new(object_name).to_constant_name}Character
+          end
+        }
+        self.const_set(characterize_item.to_constant_name + 'ControllerMethods', mod)
+        include mod
+        self.send(:helper_method, object_name)
+      end
+    end
+    
+    class Converter
+      def initialize(string)
+        @string = string.to_s
+      end
+      
+      def to_object_name
+        to_path.split('/').last
+      end
+      
+      def to_path
+        # TODO: get platform-specific path delimiter
+        @string.gsub('::','/').gsub(/([A-Z])/){ "_#{$1.downcase}" }.gsub(/^_|\/_/,'/').sub(/^\//,'')
+      end
+      
+      def to_constant_name
+        @string.gsub(/(?:^|_)([a-z])/){ $1.upcase }.gsub('/','::')
+        # TODO: get platform-specific path delimiter
+      end
+    end
+  end
+end

data/lib/characterize/feature_controls.rb

@@ -0,0 +1,83 @@
+module Characterize
+  module FeatureControls
+    
+    # Enumerate a collection with the given modules and block casting
+    # each object with the modules and uncasting the object afterward.
+    #
+    # Examples:
+    #
+    #   def each_favorite(&block)
+    #     each_with_feature(favorites, FavoriteMod, &block)
+    #   end
+    #
+    #   <%- user.each_favorite do |favorite| %>
+    #     <%= favorite.special_feature %>
+    #   <%- end -%>
+    #
+    def each_with_features(collection, *mods, &block)
+      collection.lazy.each do |obj|
+        obj.cast_as(*mods)
+        block.call(obj)
+        obj.uncast(mods.size)
+      end
+    end
+    
+    # Conditionally render content for the object.
+    #
+    # Pass in a method name for content and either of:
+    #  1. options for Rails' content_tag
+    #  2. a block to render
+    #
+    # Examples:
+    #
+    #   <%= user.with(:favorites, :p, class: 'favorites-details') %>
+    #   <%- user.with(:favorites) do %>
+    #     <p class="favorites-details">
+    #       My Favorite Things: <%= user.favorites.join(', ') %>
+    #     </p>
+    #   <%- end -%>
+    #
+    def with(method_name, *tag_name_or_options)
+      value = self.public_send(method_name)
+      if with_conditions(method_name, value)
+        if block_given?
+          yield
+        else
+          tag_name, options = *tag_name_or_options
+          view.content_tag(tag_name, value, options)
+        end
+      else
+        without_option = tag_name_or_options.last.fetch(:without){ '' }
+        if without_option.respond_to?(:call)
+          without(method_name, &without_option)
+        else
+          view.concat(without_option)
+        end
+      end
+    end
+    
+    # Conditionally render content for the object when the attribute is NOT present.
+    #
+    # Pass in a method name and a block to render.
+    #
+    # Examples:
+    #
+    #   <%- user.without(:favorites) do %>
+    #     <p class="favorites-details none">
+    #       There are no favorites here.
+    #     </p>
+    #   <%- end -%>
+    #
+    def without(method_name, &block)
+      value = self.public_send(method_name)
+      if !with_conditions(method_name, value)
+        yield
+      end
+    end
+    
+    # Used to override behavior of with for the case of special attributes
+    def with_conditions(method_name, computed_value)
+      !computed_value.nil? && computed_value != '' && computed_value != false
+    end
+  end
+end

data/lib/characterize/version.rb

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

data/lib/characterize/view_forwards.rb

@@ -0,0 +1,10 @@
+require 'forwardable'
+module Characterize
+  module ViewForwards
+    extend Forwardable
+  
+    delegate [*ActionView::Helpers.constants.map{ |name| 
+      ActionView::Helpers.const_get(name) 
+    }.map(&:instance_methods).flatten] => :__view__
+  end
+end

data/lib/characterize.rb

@@ -0,0 +1,35 @@
+require "characterize/version"
+require "characterize/controller"
+require "casting"
+
+module Characterize
+  def self.included(klass)
+    klass.class_eval {
+      include Casting::Client
+      delegate_missing_methods
+    }
+  end
+  
+  def viewable?
+    !!view
+  end
+  
+  def view
+    @view
+  end
+  
+  def __set_view__(obj)
+    @view = obj
+    self
+  end
+end
+
+require 'active_record'
+class ActiveRecord::Base
+  include Characterize
+end
+
+require 'action_controller'
+class ActionController::Base
+  include Characterize::Controller
+end

metadata

@@ -0,0 +1,98 @@
+--- !ruby/object:Gem::Specification
+name: characterize
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- "'Jim Gay'"
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-06-18 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: casting
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.6.8
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.6.8
+- !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: Use plain modules like presenters
+email:
+- jim@saturnflyer.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".ruby-version"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- characterize.gemspec
+- lib/characterize.rb
+- lib/characterize/controller.rb
+- lib/characterize/feature_controls.rb
+- lib/characterize/version.rb
+- lib/characterize/view_forwards.rb
+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: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.2.0
+signing_key: 
+specification_version: 4
+summary: Use plain modules like presenters
+test_files: []