zertico 0.1.3 → 0.2.0

data/.gitignore

@@ -15,3 +15,4 @@ spec/reports
 test/tmp
 test/version_tmp
 tmp
+.coveralls.yml

data/.travis.yml

@@ -0,0 +1,9 @@
+rvm:
+  - 1.8.7
+  - 1.9.2
+  - 1.9.3
+  - jruby
+  - ree
+gemfile:
+  - gemfiles/Gemfile.rails3.1
+  - gemfiles/Gemfile.rails3.2

data/README.md

@@ -1,6 +1,11 @@
 # Zertico
 
-TODO: Write a gem description
+[![Gem Version](https://badge.fury.io/rb/zertico.png)](http://badge.fury.io/rb/zertico) [![Build Status](https://travis-ci.org/zertico/zertico.png)](https://travis-ci.org/zertico/zertico) [![Dependency Status](https://gemnasium.com/zertico/zertico.png)](https://gemnasium.com/zertico/zertico) [![Coverage Status](https://coveralls.io/repos/zertico/zertico/badge.png?branch=master)](https://coveralls.io/r/zertico/zertico) [![Code Climate](https://codeclimate.com/github/zertico/zertico.png)](https://codeclimate.com/github/zertico/zertico)
+
+Easy Rails development using the Zertico Way.
+Rails is a great framework, but is not a great idea to let your tests depend on any part of it.
+Zertico let you develop what most important: your business logic. Also, your tests will not depend
+of rails at all.
 
 ## Installation
 
@@ -16,9 +21,69 @@ Or install it yourself as:
 
     $ gem install zertico
 
-## Usage
+## Basic Usage
+
+First, alter your ApplicationController and extend Zertico::Controller
+
+```ruby
+class ApplicationController < Zertico::Controller
+end
+```
+
+Now, define the routes you need as follow:
+
+```ruby
+resources :entries
+```
+
+And thats all. All the logic is already defined on the controller. Happy coding. =D
+
+## Advanced Usage
+
+The Zertico::Controller doesn't cover all cases. For those that are not covered you will have to
+create a service with the same name of the controller, as follows:
+
+```ruby
+class UsersController < ApplicationController
+```
+
+```ruby
+module UserService
+    include Zertico::Service
+end
+```
+
+Your service must be a module and include Zertico::Service to grant access to all the methods already defined.
+Then you will have to redefine all the methods you need. Each action of the controller is mapped to a method.
+The method has to return a hash. The key must be the name of the global variable you want to use on the views.
+
+## Conventions
+
+To work with the gem, you will need to follow some conventions. Your model ( called interface here ) need to
+have the same name of your controller, without the 'Controller' substring. The Service need to replace the
+'Controller' substring with 'Service' like:
+
+```ruby
+class UserController < Zertico::Controller
+end
+
+module UserService
+    include Zertico::Service
+end
+
+class User < ActiveRecord::Base
+end
+```
+
+It is good to put the services on a separate folder called services.
+
+## Mantainers
+
+[@plribeiro3000](https://github.com/plribeiro3000)
+
+[@mfbmina](https://github.com/mfbmina)
 
-TODO: Write usage instructions here
+[@silviolrjunio](https://github.com/silviolrjunior)
 
 ## Contributing
 

data/Rakefile

@@ -1 +1,7 @@
 require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new
+
+desc "Default Task"
+task :default => [ :spec ]

data/gemfiles/Gemfile.rails3.1

@@ -0,0 +1,5 @@
+source :rubygems
+
+gem 'rails', '3.1'
+
+gemspec :path => '../'

data/gemfiles/Gemfile.rails3.2

@@ -0,0 +1,5 @@
+source :rubygems
+
+gem 'rails', '3.2'
+
+gemspec :path => '../'

data/lib/zertico/service.rb

@@ -31,11 +31,11 @@ module Zertico
     protected
 
     def interface_name
-      self.class.name.chomp("Controller").singularize.underscore
+      self.class.name.chomp("Controller").split("::").last.singularize.underscore
     end
 
     def interface_class
       self.interface_name.camelize.constantize
     end
   end
-end
+end

data/lib/zertico/version.rb

@@ -1,3 +1,3 @@
 module Zertico
-  VERSION = "0.1.3"
+  VERSION = "0.2.0"
 end

data/spec/fake_app/admin/user_controller.rb

@@ -0,0 +1,4 @@
+module Admin
+  class UserController < Zertico::Controller
+  end
+end

data/spec/fake_app/admin/user_service.rb

@@ -0,0 +1,8 @@
+module Admin
+  module UserService
+    include Zertico::Service
+
+    def admin_user
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -1,7 +1,8 @@
 require "rspec"
+require "coveralls"
 
-require File.dirname(__FILE__) + "/../lib/zertico"
+Coveralls.wear!
 
-require File.dirname(__FILE__) + "/fake_app/user"
-require File.dirname(__FILE__) + "/fake_app/user_controller"
-require File.dirname(__FILE__) + "/fake_app/user_service"
+require "#{File.dirname(__FILE__)}/../lib/zertico"
+
+Dir["#{File.dirname(__FILE__)}/fake_app/**/*.rb"].sort.each { |f| require f }

data/spec/zertico/service_spec.rb

@@ -2,8 +2,19 @@ require "spec_helper"
 
 describe Zertico::Service do
   let(:controller) { UserController.new }
+  let(:admin_controller) { Admin::UserController.new }
   let(:object) { Object.new }
 
+  context "should find the interface class" do
+    it "on a non namespaced controller" do
+      controller.send(:interface_class).should == User
+    end
+
+    it "on a namespaced controller" do
+      admin_controller.send(:interface_class).should == User
+    end
+  end
+
   context "#all" do
     before :each do
       controller.stub_chain(:interface_name, :pluralize, :to_sym).and_return(:users)

data/zertico.gemspec

@@ -19,4 +19,5 @@ Gem::Specification.new do |gem|
 
   gem.add_runtime_dependency "rails"
   gem.add_development_dependency "rspec"
+  gem.add_development_dependency "coveralls"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: zertico
 version: !ruby/object:Gem::Version
-  version: 0.1.3
+  version: 0.2.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-05-25 00:00:00.000000000 Z
+date: 2013-05-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -43,6 +43,22 @@ dependencies:
     - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: coveralls
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 description: Easy Rails development using the Zertico Way
 email:
 - plribeiro3000@gmail.com
@@ -54,14 +70,19 @@ files:
 - .rspec
 - .ruby-gemset
 - .ruby-version
+- .travis.yml
 - Gemfile
 - LICENSE.txt
 - README.md
 - Rakefile
+- gemfiles/Gemfile.rails3.1
+- gemfiles/Gemfile.rails3.2
 - lib/zertico.rb
 - lib/zertico/controller.rb
 - lib/zertico/service.rb
 - lib/zertico/version.rb
+- spec/fake_app/admin/user_controller.rb
+- spec/fake_app/admin/user_service.rb
 - spec/fake_app/user.rb
 - spec/fake_app/user_controller.rb
 - spec/fake_app/user_service.rb
@@ -83,7 +104,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -1214307588938560788
+      hash: -3374581575376530341
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
@@ -92,7 +113,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -1214307588938560788
+      hash: -3374581575376530341
 requirements: []
 rubyforge_project: 
 rubygems_version: 1.8.25
@@ -100,6 +121,8 @@ signing_key:
 specification_version: 3
 summary: Models and patterns used by Zertico
 test_files:
+- spec/fake_app/admin/user_controller.rb
+- spec/fake_app/admin/user_service.rb
 - spec/fake_app/user.rb
 - spec/fake_app/user_controller.rb
 - spec/fake_app/user_service.rb