better_responder 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 7f5f2ce39582f2986d3bca4b49d15293a1ec1353
+  data.tar.gz: 17d665d01c95e4bb880eaeb9f979b45ae9c50f90
+SHA512:
+  metadata.gz: a8a8c02349467deaf258f16cf78002118a2ec55599fa21a7da7cf5b09b16b7680e33dd83e2e1831ee7dc358cd50ee6624c212d337a2916a737c15ec29cab872b
+  data.tar.gz: f0c15aee9bd2946ee7c0416becd16c37a435d632e8b06cebe1655a03db6e169fca2621c154002bf6009792d65182eec30f7b793d02ee74a9344a4082d4ba8b28

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/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in better_responder.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 sergio1990
+
+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,119 @@
+# BetterResponder
+
+Small tweak for rendering decision.
+
+## Getting started
+
+How many times you may see in the controller the code like this:
+
+```ruby
+def create
+  @post = @conversation.posts.build post_params
+  @post.user = current_user
+  if @post.save
+    redirect_to @conversation, notice: I18n.t(...)
+  else
+    render :new
+  end
+end
+
+def update
+  if @post.update_attributes
+    redirect_to @conversation, notice: I18n.t(...)
+  else
+    render :edit
+  end
+end
+
+def destroy
+  if @post.destroy
+    redirect_to @conversation, notice: I18n.t(...)
+  else
+    redirect_to @conversation, alert: I18n.t(...)
+  end
+end
+```
+
+This code is valid but for me it contains some duplication and it needs to refactor.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'better_responder'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install better_responder
+
+Or if you want to stay on the edge:
+
+    gem 'better_responder', github: 'sergio1990/better_responder'
+
+
+## Usage
+
+For first you need to initialize Responder object. At this time, I recommend you to do this in Application Controller:
+
+```ruby
+  before_action :create_responder #You must use before_filter for rails < 4
+
+  private
+
+  def create_responder
+    @responder ||= BetterResponder::Responder.new(self)
+  end
+```
+
+Next, refactor code that was shown earlier:
+
+```ruby
+  def create
+    @post = @conversation.posts.new post_params
+    @post.user = current_user
+    @responder.run @post.save, {redirect_to: @conversation}, {render: :new}
+  end
+
+  def update
+    @responder.run @post.update_attributes(post_params), {redirect_to: @conversation}, {render: :edit}
+  end
+
+  def destroy
+    @responder.run @post.destroy, {redirect_to: @conversation}
+  end
+```
+
+Now we simplify your code by calling single __@responder.run__. IMHO this looks small bit better. However, I dont like to manually calling @responder.run each time and this problem I will solve.
+
+## Flash messages
+
+For right using flash messages inside Responder you must declare translations accordingly this pattern:
+
+```
+  responder.#{controller_name}.#{action_name}.#{type}
+```
+
+Type is a finite set of _[success, fail]_.
+
+For example:
+
+```yaml
+  ru:
+    responder:
+      posts:
+        destroy:
+          success: Your success message
+          fail: Your fail message
+```
+
+## 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/better_responder.gemspec

@@ -0,0 +1,25 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'better_responder/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "better_responder"
+  spec.version       = BetterResponder::VERSION
+  spec.authors       = ["sergio1990"]
+  spec.email         = ["sergeg1990@gmail.com"]
+  spec.description   = %q{Small tweak for rendering decision}
+  spec.summary       = spec.description
+  spec.homepage      = "https://github.com/sergio1990/better_responder"
+  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 'i18n'
+
+  spec.add_development_dependency "bundler", "~> 1.3"
+  spec.add_development_dependency "rake"
+end

data/lib/better_responder.rb

@@ -0,0 +1,5 @@
+require "better_responder/version"
+
+module BetterResponder
+  autoload :Responder, 'better_responder/responder'
+end

data/lib/better_responder/responder.rb

@@ -0,0 +1,39 @@
+module BetterResponder
+  class Responder
+
+    def initialize(context)
+      @context = context
+    end
+
+    def run(condition, success_render, fail_render = nil)
+      provide_response condition ? [success_render, :success] : [fail_render || success_render, :fail]
+    end
+
+    private
+
+    def provide_response(params)
+      render_params = params.first
+      render_type = params[1]
+      method = render_params.keys.first
+      @context.send method, render_params[method], :"#{flash_type(render_type)}" => I18n.t(message_builder(render_type))
+    end
+
+    def message_builder(type)
+      "responder.#{controller_name}.#{action_name}.#{type}"
+    end
+
+    def action_name
+      @context.params[:action]
+    end
+
+    def controller_name
+      @context.class.name.underscore.split("_").first
+    end
+
+    def flash_type(render_type)
+      h = {success: :notice, fail: :alert}
+      h[render_type.to_sym]
+    end
+
+  end
+end

data/lib/better_responder/version.rb

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

metadata

@@ -0,0 +1,95 @@
+--- !ruby/object:Gem::Specification
+name: better_responder
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- sergio1990
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-11-26 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: i18n
+  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'
+- !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: Small tweak for rendering decision
+email:
+- sergeg1990@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- better_responder.gemspec
+- lib/better_responder.rb
+- lib/better_responder/responder.rb
+- lib/better_responder/version.rb
+homepage: https://github.com/sergio1990/better_responder
+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.0.6
+signing_key: 
+specification_version: 4
+summary: Small tweak for rendering decision
+test_files: []