characterize 0.0.2 → 0.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 00e40cca8ad8624b4a6ab85ab521ecdb08f2f689
-  data.tar.gz: c791593bc4a01b224dfc37ee944417239b6e10a7
+  metadata.gz: 6dd6c5bddafaef5e7619904642a61bc18e4d3ceb
+  data.tar.gz: b19c6b3417f70fed51cceaad19951ab356fd2c4c
 SHA512:
-  metadata.gz: e690b1251155f2cab4e14ae3a021efa95f68a99ad5ec2881032f7a3b774091b1eecdc45e1beb0ae6760d04a363781165ea6c683e72c68f117a6e824da2a5edf0
-  data.tar.gz: f1613c4bd503315e41676a77daa47fe76a32c0a4fc460cb79d973000dc58df6d33a972f78a3c9e1b6ba555fe01ff01fdf9f210758c04b92f98f2255d371bc797
+  metadata.gz: 604831f80be02bc1fa74f7d4db542ec6dd082d8b738364fd9cff991432c882df576aa7eebf396895198f83a8806d598ae8400bd4d39fd1da05beb6079cc1df7a
+  data.tar.gz: b2d21c279d3c1752da601c02731f7c9dfa4f8ba3c6c03f3f3bd55324e11ea518f2cfaf8ded55d5c602f9d824c5312a85fdabbefffcacff00b53b971f18930c64

data/.travis.yml

@@ -0,0 +1,16 @@
+language: ruby
+rvm:
+  - 1.9.3
+  - 2.0.0
+  - 2.1.0
+  - jruby-19mode # JRuby in 1.9 mode
+  - ruby-head
+  - jruby-head
+  - rbx-2
+env:
+- COVERALLS=true
+matrix:
+  allow_failures:
+    - rvm: ruby-head
+    - rvm: jruby-head
+    - rvm: rbx-2

data/Gemfile

@@ -4,7 +4,11 @@ source 'https://rubygems.org'
 gemspec
 
 group :test do
-  gem 'sqlite3'
+  gem 'activerecord-jdbcsqlite3-adapter', '>= 1.3.0.rc1', platform: :jruby
+  gem 'sqlite3', platform: :ruby
   gem 'rails'
   gem 'minitest-spec-rails'
+  gem 'rubinius-coverage', platform: :rbx
+  gem 'coveralls', require: false
+  gem 'simplecov'
 end

data/README.md

@@ -1,6 +1,16 @@
 # Characterize
 
-Make your models behave in special ways.
+Make your models behave in special ways without wrapping them.
+
+Characterize is built on top of [Casting](https://github.com/saturnflyer/casting) and makes it easy to get going in Rails.
+
+[![Build Status](https://travis-ci.org/saturnflyer/characterize.png?branch=master)](https://travis-ci.org/saturnflyer/characterize)
+[![Code Climate](https://codeclimate.com/github/saturnflyer/characterize.png)](https://codeclimate.com/github/saturnflyer/characterize)
+[![Coverage Status](https://coveralls.io/repos/saturnflyer/characterize/badge.png)](https://coveralls.io/r/saturnflyer/characterize)
+[![Gem Version](https://badge.fury.io/rb/characterize.png)](http://badge.fury.io/rb/characterize)
+
+
+
 
 ## Usage
 
@@ -13,6 +23,12 @@ class UsersController < ApplicationController
 end
 # the above sets a helper_method of 'user' and loads UserCharacter
 
+module UserCharacter
+  def special_behavior_available_in_the_view
+     # ...
+  end
+end
+
 class UsersController < ApplicationController
   def show
     characterize(user, display_module)
@@ -38,6 +54,57 @@ module StandardUser
 end
 ```
 
+Set special modules to be used for different actions:
+
+```ruby
+class UsersController < ApplicationController
+  characterize :user, show: [SpecialStuff, StandardStuff],
+                      edit: [EditingCharacter],
+                      default: [StandardStuff]
+
+  def show
+  end
+end
+```
+
+By default Characterize will look for modules that match the name of your object. So `characterize :user` would apply a `UserCharacter` module (and will blow up if it can't find it.) Or you can override it with the above configuration.
+
+## Atering the Settings
+
+### Module names
+
+Characterize will automatically look for modules using the "Character" suffix in it's name. But you can change this if you like.
+
+Just create an initializer which will change the setting when your Rails application boots:
+
+```ruby
+Characterize.module_suffix = 'Details'
+```
+
+With the above change, using `characterize :user` in your controller, it will attempt to load `UserDetails` instead of `UserCharacter`. This will apply for your *entire* application; if you only want to override the suffix in some places, just specify the module you want in your controller.
+
+### Creating your own standard features
+
+By default Characterize has some helpful features built in. You can use them like this:
+
+```ruby
+class UsersController < ApplicationController
+  characterize :user, show: [SpecialStuff].concat(Characterize.standard_features)
+
+  def show
+  end
+end
+```
+
+That will load the built-in features from Characterize. But you can change what is considered "standard" in your application.
+
+Set the `standard_features` option in your initializer to whatever you want:
+
+```ruby
+original_features = Characterize.standard_features
+Characterize.standard_features = [MyAwesomeStuff, ExtraDoodads].concat(original_features)
+```
+
 ## Installation
 
 Add this line to your application's Gemfile:

data/characterize.gemspec

@@ -18,7 +18,7 @@ Gem::Specification.new do |spec|
   spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
   spec.require_paths = ["lib"]
   
-  spec.add_dependency "casting", "~> 0.6.8"
+  spec.add_dependency "casting", "~> 0.7.1"
 
   spec.add_development_dependency "bundler", "~> 1.3"
   spec.add_development_dependency "rake"

data/lib/characterize.rb

@@ -1,5 +1,6 @@
 require "characterize/version"
 require "characterize/controller"
+require 'characterize/feature_controls'
 require "casting"
 require 'characterize/railtie' if defined?(::Rails)
 
@@ -12,11 +13,31 @@ module Characterize
   end
   
   def view
-    @view
+    @characterize_view
   end
   
-  def __set_view__(obj)
-    @view = obj
+  def __set_characterize_view__(obj)
+    @characterize_view = obj
     self
   end
+
+  def self.module_suffix
+    @characterize_suffix ||= 'Character'
+  end
+
+  def self.module_suffix=(val)
+    @characterize_suffix = val
+  end
+
+  def self.standard_features
+    @standard_features ||= builtin_standard_features
+  end
+
+  def self.standard_features=(mods_array)
+    @standard_features = mods_array
+  end
+
+  def self.builtin_standard_features
+    [::Characterize::FeatureControls]
+  end
 end

data/lib/characterize/controller.rb

@@ -1,5 +1,3 @@
-require 'characterize/feature_controls'
-
 module Characterize
   module Controller
     def self.included(klass)
@@ -9,21 +7,17 @@ module Characterize
     private
 
     def characterize(obj, *mods)
-      obj.__set_view__(view_context).cast_as(*mods)
+      obj.__set_characterize_view__(view_context).cast_as(*mods)
       obj
     end
 
     def characters_for_action(object_name, action_name)
-      if self.respond_to?("#{object_name}_#{action_name}_characters") && action_methods.include?(action_name.to_s)
-        Array(self.send("#{object_name}_#{action_name}_characters"))
+      if self.respond_to?("#{object_name}_#{action_name}_features") && action_methods.include?(action_name.to_s)
+        Array(self.send("#{object_name}_#{action_name}_features"))
       else
-        self.send("default_#{object_name}_characters")
+        self.send("default_#{object_name}_features")
       end
     end
-
-    def self.view_features
-      [::Characterize::FeatureControls]
-    end
   end
   
   module ControllerMacros
@@ -35,7 +29,7 @@ module Characterize
       actions_hash = options.last
 
       object_constant_name = object_name.to_s.gsub(/(?:^|_)([a-z])/){ $1.upcase }.gsub('/','::')
-      default_characters = actions_hash.delete(:default) || ["::#{object_constant_name}Character"]
+      default_features = actions_hash.delete(:default) || ["::#{object_constant_name}#{Characterize.module_suffix}"]
 
       mod = Module.new
       mod.module_eval %{
@@ -48,13 +42,13 @@ module Characterize
           #{object_constant_name}.find(params[:id])
         end
 
-        def default_#{object_name}_characters
-          [#{default_characters.map(&:to_s).join(', ')}]
+        def default_#{object_name}_features
+          [#{default_features.map(&:to_s).join(', ')}]
         end
       }
       actions_hash.each_pair do |action_name, characters|
         mod.module_eval %{
-          def #{object_name}_#{action_name}_characters
+          def #{object_name}_#{action_name}_features
             [#{characters.map(&:to_s).join(', ')}]
           end
         }

data/lib/characterize/version.rb

@@ -1,3 +1,3 @@
 module Characterize
-  VERSION = "0.0.2"
+  VERSION = "0.0.3"
 end

data/test/characterize_test.rb

@@ -1,8 +1,14 @@
 require 'test_helper'
 
 describe UsersController do
-  it 'renders views with extra features from characters' do
+  it 'renders views with extra features from default characters' do
     get :show, id: '1'
     assert_template :show
+    assert_select 'a', 'm( O.O )m'
+  end
+
+  it 'renders objects with extra features from specified characters' do
+    get :edit, id: '1'
+    assert_equal "Yay! Special title", response.body
   end
 end

data/test/internal/app/characters/edit_user_character.rb

@@ -0,0 +1,5 @@
+module EditUserCharacter
+  def editing_title
+    "Yay! Special title"
+  end
+end

data/test/internal/app/controllers/users_controller.rb

@@ -1,6 +1,10 @@
 class UsersController < ApplicationController
-  characterize :user, default: [SpecialCharacter]
+  characterize :user, default: [SpecialCharacter],
+                      edit: [EditUserCharacter]
   
   def show; end
+  def edit
+    render :text => user.editing_title
+  end
   
 end

data/test/internal/config/database.yml

@@ -18,8 +18,4 @@ development:
 # Do not set this db to the same as development or production.
 test:
   <<: *default
-  database: db/test.sqlite3
-
-production:
-  <<: *default
-  database: db/production.sqlite3
+  database: db/test.sqlite3

data/test/internal/config/routes.rb

@@ -1,3 +1,3 @@
 Rails.application.routes.draw do
-  resources :users, only: [:show]
+  resources :users, only: [:show, :edit]
 end

data/test/test_helper.rb

@@ -1,3 +1,13 @@
+require 'simplecov'
+SimpleCov.start do
+  add_filter 'test'
+end
+
+require 'coveralls'
+if ENV['COVERALLS']
+  Coveralls.wear!
+end
+
 # Configure Rails Environment
 ENV["RAILS_ENV"] = "test"
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: characterize
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.0.3
 platform: ruby
 authors:
 - "'Jim Gay'"
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-06-22 00:00:00.000000000 Z
+date: 2015-01-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: casting
@@ -16,14 +16,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.6.8
+        version: 0.7.1
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.6.8
+        version: 0.7.1
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -60,7 +60,7 @@ extensions: []
 extra_rdoc_files: []
 files:
 - ".gitignore"
-- ".ruby-version"
+- ".travis.yml"
 - Gemfile
 - LICENSE.txt
 - README.md
@@ -78,6 +78,7 @@ files:
 - test/internal/app/assets/images/.keep
 - test/internal/app/assets/javascripts/application.js
 - test/internal/app/assets/stylesheets/application.css
+- test/internal/app/characters/edit_user_character.rb
 - test/internal/app/characters/special_character.rb
 - test/internal/app/characters/user_character.rb
 - test/internal/app/controllers/application_controller.rb
@@ -142,7 +143,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.2.0
+rubygems_version: 2.4.5
 signing_key: 
 specification_version: 4
 summary: Use plain modules like presenters
@@ -153,6 +154,7 @@ test_files:
 - test/internal/app/assets/images/.keep
 - test/internal/app/assets/javascripts/application.js
 - test/internal/app/assets/stylesheets/application.css
+- test/internal/app/characters/edit_user_character.rb
 - test/internal/app/characters/special_character.rb
 - test/internal/app/characters/user_character.rb
 - test/internal/app/controllers/application_controller.rb

data/.ruby-version

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