tuning 0.3.3 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 18821f4d89a8574296569885f2551ec2af4d9940
-  data.tar.gz: 2ff074c48720859869d3b1ab9dbdbdfa410c1f48
+  metadata.gz: 343b848737c55c9904274280fa22d39825774cd6
+  data.tar.gz: d958a82c6f8109cc0349978d59bbc23fda0ce85c
 SHA512:
-  metadata.gz: 6c365fc74873b685e28a083955554c89e5d8a0541c19186dafd0e51a593a9be0abfbc3da312acc1aaed6373c1aab50f5f7e88786840f4cb05433be88782aed2f
-  data.tar.gz: a4b6237569666ae1fd478eb5f08e6a2b853ba579d37eae5f25c31a2660d9586981d8646d85240f4ebaaf3b732f434fb6f8425e8dcbd94d40f7ac1b3a326e2de9
+  metadata.gz: 49d74ede892d4044c00902cc3ddd33cb405fa79b00406e3ad975a3b2b1eb0b72337ad13fad9899580da53b4e9983b25562b8be877abc49bbded7c8fb4a651f1a
+  data.tar.gz: 3641e84db0a2bc40ab09def6907be2b3a60e6efccd3c2ede3de92f620583f1eaad6655efec327171623f5767c81867807bc035e64a23cf48f95556335130f0dc

data/MIT-LICENSE

@@ -1,4 +1,4 @@
-Copyright 2015 Mathías Montossi
+Copyright 2016 Mathías Montossi
 
 Permission is hereby granted, free of charge, to any person obtaining
 a copy of this software and associated documentation files (the

data/README.md

@@ -21,45 +21,108 @@ $ bundle
 
 ## Controllers
 
-Use error method to respond with status 500 and show 500.html (if format it's html):
+New callbacks before, after, around render are available:
 ```ruby
-error
-```
+class ProductsController < ApplicationController
 
-Use not_found to respond with status 404 and show 404.html (if format it's html):
-```ruby
-not_found
+  before_action :set_product
+  before_render :prepare_product
+
+  def edit
+  end
+
+  private
+
+  def set_product
+    @product = Product.find(params[:id])
+  end
+
+  def prepare_product
+    @product.build_picture
+  end
+
+end
 ```
 
-Use unauthorized to respond with status 401 and show 422.html (if format it's html):
-```ruby
-unauthorized
+## Mailers
+
+Text email templates will normalize spaces and new lines like html:
+```erb
+<% if @order.confirmed? %>
+  Your order has been confirmed.
+
+  Will be delivered right the way.
+<% end %>
 ```
 
-Use forbidden to respond with status 403 and show 422.html (if format it's html):
-```ruby
-forbidden
+Will produce:
 ```
+Your order has been confirmed.
 
-Use unprocessable_entity to respond with status 422 and show 422.html (if format it's html):
-```ruby
-unprocessable_entity
+Will be delivered right the way.
 ```
 
 ## Views
 
-Use content_tag_if if you want wrap content into some tag if certain condition it's true:
+New content_tag_if method to wrap content into some tag if certain condition it's true:
 ```erb
 <%= content_tag_if request.path == home_path, :h1 do %>
   <%= link_to 'Home', home_path, id: 'logo' %>
 <% end %>
 ```
 
-Use active_trail? if you want to check if some path is on active trail:
+New active_trail? method to check if some path is on active trail:
 ```erb
 <li class="<%= 'active' if active_trail? some_path %>"></li>
 ```
 
+New extending method to extend layouts:
+```erb
+<%= extending :application do %>
+  <p>content</p>
+<% end %>
+```
+
+## Records
+
+Empty strings will be nilify in the database to avoid sql errors or complex queries:
+```ruby
+shop = Shop.new(name: '')
+shop.save
+shop.name # Will be nil
+```
+
+New method validate is available to allow a more expressive syntax:
+```ruby
+record.validate # Same as valid?
+```
+
+## Validations
+
+Complexity validator to avoid weak passwords:
+```ruby
+class User < ActiveRecord::Base
+  validates_complexity_of :password
+end
+```
+
+Count validator to express count messages instead of length messages:
+```ruby
+class Product < ActiveRecord::Base
+  validates_count_of :pictures, minimum: 1, maximum: 4 # Or in/within: 1..4
+end
+```
+
+Time validator to validate Date/Time values:
+```ruby
+class Schedule < ActiveRecord::Base
+  validates_time_of :opens_at
+  validates_time_of :closes_at, after: :opens_at # Or before, after_or_equal_to or before_or_equal_to
+end
+```
+
+NOTE: Take a look at lib/tuning/locales to know the i18n keys.
+
 ## Credits
 
 This gem is maintained and funded by [mmontossi](https://github.com/mmontossi).

data/Rakefile

@@ -19,6 +19,9 @@ end
 
 Bundler::GemHelper.install_tasks
 
+APP_RAKEFILE = File.expand_path('../test/dummy/Rakefile', __FILE__)
+load 'rails/tasks/engine.rake'
+
 require 'rake/testtask'
 
 Rake::TestTask.new(:test) do |t|

data/lib/tuning.rb

@@ -1,5 +1,10 @@
-require 'tuning/action_controller/base'
-require 'tuning/action_view/base'
+require 'tuning/extensions/action_controller/base'
+require 'tuning/extensions/action_mailer/base'
+require 'tuning/extensions/action_view/base'
+require 'tuning/extensions/active_record/base'
+require 'tuning/validations/complexity'
+require 'tuning/validations/count'
+require 'tuning/validations/time'
 require 'tuning/railtie'
 
 module Tuning

data/lib/tuning/extensions/action_controller/base.rb

@@ -0,0 +1,45 @@
+module Tuning
+  module Extensions
+    module ActionController
+      module Base
+        extend ActiveSupport::Concern
+
+        included do
+          define_callbacks :render
+        end
+
+        def render(*args)
+          run_callbacks(:render) do
+            super
+          end
+        end
+
+        module ClassMethods
+
+          %i(before after around).each do |callback|
+            define_method "#{callback}_render" do |*names, &block|
+              _insert_callbacks(args, block) do |name, options|
+                set_callback :render, callback, name, options
+              end
+            end
+
+            define_method "prepend_#{callback}_render" do |*names, &block|
+              _insert_callbacks(args, block) do |name, options|
+                set_callback :render, callback, name, options.merge(prepend: true)
+              end
+            end
+
+            define_method "skip_#{callback}_render" do |*names|
+              _insert_callbacks(args) do |name, options|
+                skip_callback :render, callback, name, options
+              end
+            end
+
+            alias_method :"append_#{callback}_render", :"#{callback}_render"
+          end
+
+        end
+      end
+    end
+  end
+end

data/lib/tuning/extensions/action_mailer/base.rb

@@ -0,0 +1,22 @@
+module Tuning
+  module Extensions
+    module ActionMailer
+      module Base
+        extend ActiveSupport::Concern
+
+        included do
+          after_action :normalize_text_body
+        end
+
+        private
+
+        def normalize_text_body
+          if mail.content_type.starts_with?('text/plain')
+            mail.body = mail.body.to_s.gsub(/\n{3,}/, "\n\n").gsub(/\n +/, "\n").gsub(/^ +/, '')
+          end
+        end
+
+      end
+    end
+  end
+end

data/lib/tuning/extensions/action_view/base.rb

@@ -0,0 +1,31 @@
+module Tuning
+  module Extensions
+    module ActionView
+      module Base
+        extend ActiveSupport::Concern
+
+        def active_trail?(path)
+          (path == '/' && request.path == path) || request.path.start_with?(path)
+        end
+
+        def content_tag_if(condition, name, options={}, &block)
+          if condition
+            content_tag(name, options, &block)
+          else
+            capture(&block)
+          end
+        end
+
+        def extending(layout, &block)
+          if block_given?
+            old_layout = @view_flow.get(:layout)
+            new_layout = (capture(&block) || '')
+            old_layout.replace(new_layout)
+          end
+          render file: "layouts/#{layout}"
+        end
+
+      end
+    end
+  end
+end

data/lib/tuning/extensions/active_record/base.rb

@@ -0,0 +1,25 @@
+module Tuning
+  module Extensions
+    module ActiveRecord
+      module Base
+        extend ActiveSupport::Concern
+
+        included do
+          before_save :nilify_blank_attributes
+          alias_method :validate, :valid?
+        end
+
+        private
+
+        def nilify_blank_attributes
+          attributes.each do |column, value|
+            if value.is_a? String and value.blank?
+              self[column] = nil
+            end
+          end
+        end
+
+      end
+    end
+  end
+end

data/lib/tuning/locales/en.yml

@@ -0,0 +1,12 @@
+en:
+  errors:
+    messages:
+      too_easy: "is too easy"
+      too_many: "must have maximum %{count}"
+      too_few: "must have minimum %{count}"
+      wrong_count: "must have %{count}"
+      not_a_time: "is not a time"
+      after: "must be after %{time}"
+      after_or_equal_to: "must be after or equal to %{time}"
+      before: "must be before %{time}"
+      before_or_equal_to: "must be before or equal to %{time}"

data/lib/tuning/locales/es.yml

@@ -0,0 +1,12 @@
+es:
+  errors:
+    messages:
+      too_easy: "es muy fácil"
+      too_many: "debe tener máximo %{count}"
+      too_few: "debe tener mínimo %{count}"
+      wrong_count: "debe tener %{count}"
+      not_a_time: "no es un tiempo"
+      after: "debe ser posterior a %{time}"
+      after_or_equal_to: "tiene que ser posterior o igual a %{time}"
+      before: "debe ser anterior a %{time}"
+      before_or_equal_to: "tiene que ser anterior o igual a %{time}"

data/lib/tuning/railtie.rb

@@ -1,9 +1,23 @@
 module Tuning
   class Railtie < Rails::Railtie
 
-    initializer 'tuning' do
-      ::ActionController::Base.send :include, Tuning::ActionController::Base
-      ::ActionView::Base.send :include, Tuning::ActionView::Base
+    initializer :tuning do
+      ::ActionController::Base.include(
+        Tuning::Extensions::ActionController::Base
+      )
+      ::ActionMailer::Base.include(
+        Tuning::Extensions::ActionMailer::Base
+      )
+      ::ActionView::Base.include(
+        Tuning::Extensions::ActionView::Base
+      )
+      ::ActiveRecord::Base.include(
+        Tuning::Extensions::ActiveRecord::Base,
+        Tuning::Validations
+      )
+      ::ActiveModel::Model.include(
+        Tuning::Validations
+      )
     end
 
   end

data/lib/tuning/validations/complexity.rb

@@ -0,0 +1,22 @@
+module Tuning
+  module Validations
+    extend ActiveSupport::Concern
+
+    class ComplexityValidator < ActiveModel::EachValidator
+
+      def validate_each(record, attribute, value)
+        if value !~ /\A(?=.*[a-z])(?=.*[A-Z])(?=.*[\d])(?=.*[\W\_]).{8,}*\z/
+          record.errors.add attribute, :too_easy
+        end
+      end
+
+    end
+    module ClassMethods
+
+      def validates_complexity_of(*attr_names)
+        validates_with ComplexityValidator, _merge_attributes(attr_names)
+      end
+
+    end
+  end
+end

data/lib/tuning/validations/count.rb

@@ -0,0 +1,42 @@
+module Tuning
+  module Validations
+    extend ActiveSupport::Concern
+
+    class CountValidator < ActiveModel::EachValidator
+      MESSAGES = { is: :wrong_count, minimum: :too_few, maximum: :too_many }
+      CHECKS = { is: :==, minimum: :>=, maximum: :<= }
+
+      def initialize(options)
+        if range = (options[:in] || options[:within])
+          options[:minimum] = range.min
+          options[:maximum] = range.max
+        end
+        super
+      end
+
+      def validate_each(record, attribute, value)
+        if value.respond_to?(:size)
+          count = value.size
+          CHECKS.each do |name, operator|
+            if options.has_key?(name)
+              other = options[name]
+              unless count.send(operator, other)
+                record.errors.add attribute, MESSAGES[name], count: other
+              end
+            end
+          end
+        else
+          record.errors.add attribute, :uncountable
+        end
+      end
+
+    end
+    module ClassMethods
+
+      def validates_count_of(*attr_names)
+        validates_with CountValidator, _merge_attributes(attr_names)
+      end
+
+    end
+  end
+end

data/lib/tuning/validations/time.rb

@@ -0,0 +1,38 @@
+module Tuning
+  module Validations
+    extend ActiveSupport::Concern
+
+    class TimeValidator < ActiveModel::EachValidator
+      CHECKS = { before: :<, before_or_equal_to: :<=, after: :>, after_or_equal_to: :>= }
+
+      def validate_each(record, attribute, value)
+        if [Date, Time].any? { |klass| value.kind_of?(klass) }
+          CHECKS.each do |name, operator|
+            if options.has_key?(name)
+              other = options[name]
+              case other
+              when Symbol
+                other = record.send(other)
+              when Proc
+                other = other.call(record)
+              end
+              unless value.send(operator, other)
+                record.errors.add attribute, name, time: I18n.l(other)
+              end
+            end
+          end
+        else
+          record.errors.add attribute, :not_a_time
+        end
+      end
+
+    end
+    module ClassMethods
+
+      def validates_time_of(*attr_names)
+        validates_with TimeValidator, _merge_attributes(attr_names)
+      end
+
+    end
+  end
+end