support_utils 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 0aa086704ed53641c59928f9ec247ea97688b3ad
+  data.tar.gz: 0ac049d8aa70e95ccdbfc64c1f530b8014098771
+SHA512:
+  metadata.gz: 6577e353ebb8485da58f9c8a0ae7bbd1e0499a8b02a7a48387a39631fc0d317be990acf36385b6405ab249b8a15282e1281643f5504fef0c29772bfcc18275d3
+  data.tar.gz: e7c53f57883658ba6ba5692a0c5ed80cc5b4677fdd2ca1e3c5dc9d3cbb3f0b1682299bdff51dfc969759b61c92a7543c9b6784531d7b2b3bb5e4a1395a516cd1

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2015 Emilio Forrer
+
+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,243 @@
+**SupportUtils**
+===================
+
+SupportUtils is a collection of utility classes, helpers and standard library extensions that were found useful for develop projects, faster.
+
+----------
+
+
+**Installation**
+------------
+
+
+
+Add this line to your application's Gemfile:
+
+```
+gem 'support_utils'
+```
+
+And then execute:
+
+```
+bundle install
+```
+
+Or install it yourself as:
+
+```
+$ gem install support_utils
+```
+<div style="page-break-after: always;"></div>
+
+##**Usage**
+
+### Active Record Models
+
+To have available all the extra methods and helpers in your models, simply just call the `has_utils` method inside your model. Example:
+
+```
+class Order < ActiveRecord::Base
+  has_utils
+  belongs_to :user
+end
+
+```
+
+### List of methods added to your models
+
+###  **`Model#column_name_format`**
+
+This method behaves diferently depending on the type of the column in the database, here is the list behavior by type:
+
+####  **`Model#column_name_format format, options`** - column type (Date, Datetime, etc)
+
+When you call `Model#column_name_format` on a date column, it will use the `I18n.locale` and return the date formated.
+
+List of arguments
+
+* **format:** the format that is going to use to display the date. **Default value** **`:default`**.
+
+Example using the completed_at attribute of the Order class.
+
+```
+order = Order.first
+
+order.completed_at
+=> Sat, 25 Apr 2015 18:29:40 UTC +00:00
+
+# Default format
+
+order.completed_at_format
+ => "Sat, 25 Apr 2015 18:29:40 +0000"
+
+# Short format
+
+order.completed_at_format :short
+  => "25 Apr 18:29"
+
+```
+
+
+
+####  **`Model#column_name_format  options`** - column type (Float, Decimal)
+
+
+When you call `Model#column_name_format` on a decimal column, it will use some number helpers (such as `number_with_precision` and `number_to_currency`) to display the value.
+
+List of options
+
+* **currency:** if set to true it will call `number_to_currency` to display the value.
+
+Example using the total attribute of the Order class.
+
+```
+order = Order.first
+
+order.total.to_s
+ => "29.15586957"
+
+# Default
+
+order.total_format
+ => "29.16"
+
+# Currency
+
+order.total_format currency: true
+ => "$29.16"
+
+# Currency diferent unit
+
+order.total_format currency: true, unit: "€"
+ => "€29.16"
+
+
+```
+
+<div style="page-break-after: always;"></div>
+
+####  **`Model#column_name_format  options`** - column type (String, Text)
+
+
+When you call `Model#column_name_format` on a string column, it will use some text helpers (such as `simple_format` and `truncate`) to display the value. By default uses `simple_format`.
+
+List of options
+
+* **truncate:** Truncates a given text after a given :length if text is longer than :length (defaults to 30). The last characters will be replaced with the :omission (defaults to “…”) for a total length not exceeding :length.
+* **word_wrap:** Wraps the text into lines no longer than line_width width. This method breaks on the first whitespace character that does not exceed line_width (which is 80 by default).
+* **excerpt:** Extracts an excerpt from text that matches the first instance of phrase.
+
+
+Example using the description attribute of the Order class.
+
+
+```
+order = Order.first
+
+order.description
+ => "Excepturi eum eius sed quia sint fuga veritatis. Nihil nisi omnis ullam voluptatem doloremque iure. Rerum eum recusandae est sit qui odio eum. Et laboriosam voluptas. Beatae qui voluptates velit est soluta. Fugiat ut omnis impedit voluptas alias."
+
+# Default - simple_format
+
+order.description_format
+ => "<p>Excepturi eum eius sed quia sint fuga veritatis. Nihil nisi omnis ullam voluptatem doloremque iure. Rerum eum recusandae est sit qui odio eum. Et laboriosam voluptas. Beatae qui voluptates velit est soluta. Fugiat ut omnis impedit voluptas alias.</p>"
+
+
+# truncate
+
+order.description_format truncate: true
+ => "Excepturi eum eius sed quia..."
+
+
+ order.description_format truncate: {length: 10}
+ => "Exceptu..."
+
+# word_wrap
+
+order.description_format word_wrap:  true
+ => "Excepturi eum eius sed quia sint fuga veritatis. Nihil nisi omnis ullam\nvoluptatem doloremque iure. Rerum eum recusandae est sit qui odio eum. Et\nlaboriosam voluptas. Beatae qui voluptates velit est soluta. Fugiat ut omnis\nimpedit voluptas alias."
+
+
+# highlight
+
+order.description_format highlight: {phrases: "eum"}
+ => "Excepturi <mark>eum</mark> eius sed quia sint fuga veritatis. Nihil nisi omnis ullam voluptatem doloremque iure. Rerum <mark>eum</mark> recusandae est sit qui odio <mark>eum</mark>. Et laboriosam voluptas. Beatae qui voluptates velit est soluta. Fugiat ut omnis impedit voluptas alias."
+
+
+# excerpt
+
+order.description_format excerpt:  {phrase: "fuga", radius: 10}
+ => "...quia sint fuga veritatis..."
+
+
+```
+
+<div style="page-break-after: always;"></div>
+
+###  **`Model#column_name?`**
+
+If you create a column with integer as data type and with a length of 1, this method gets overwritten so it return true only if is equals to 1.
+
+
+Example using the active attribute of the User class.
+
+
+```
+# migration
+
+class CreateUsers < ActiveRecord::Migration
+  def change
+    create_table :users do |t|
+      t.string     :email
+      t.string     :first_name
+      t.string     :last_name
+      t.integer    :active, limit: 1
+      t.datetime   :confirmed_at
+      t.timestamps null: false
+    end
+  end
+end
+
+```
+
+```
+user = User.first
+
+user.active
+=> nil
+
+user.active?
+ => false
+
+user.active = 1
+ => 1
+
+user.active?
+ => true
+
+user.active = 0
+ => 0
+
+user.active?
+ => false
+
+```
+
+
+###  **`Model.truncate(confirm)`**
+
+Truncate the table reseting the primary key
+
+
+```
+Order.truncate! true
+=> (30.0ms)  DELETE FROM orders
+   (8.5ms)  DELETE FROM sqlite_sequence WHERE name='orders'
+
+```
+
+**Note:** since `sqlite` does't support the `truncate` statement it will delete the record and the sequence
+
+
+---------

data/Rakefile

@@ -0,0 +1,43 @@
+begin
+  require 'bundler/setup'
+rescue LoadError
+  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+end
+
+require 'rdoc/task'
+
+RDoc::Task.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'SupportUtils'
+  rdoc.options << '--line-numbers'
+  rdoc.rdoc_files.include('README.rdoc')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+APP_RAKEFILE = File.expand_path("../test/dummy/Rakefile", __FILE__)
+load 'rails/tasks/engine.rake'
+
+
+load 'rails/tasks/statistics.rake'
+
+
+
+Bundler::GemHelper.install_tasks
+
+require 'rake/testtask'
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'lib'
+  t.libs << 'test'
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = false
+end
+
+begin
+  require 'rspec/core/rake_task'
+  RSpec::Core::RakeTask.new(:spec)
+  task :default => :spec
+rescue LoadError
+end
+
+task default: :test

data/app/assets/javascripts/support_utils/application.js

@@ -0,0 +1,13 @@
+// This is a manifest file that'll be compiled into application.js, which will include all the files
+// listed below.
+//
+// Any JavaScript/Coffee file within this directory, lib/assets/javascripts, vendor/assets/javascripts,
+// or any plugin's vendor/assets/javascripts directory can be referenced here using a relative path.
+//
+// It's not advisable to add code directly here, but if you do, it'll appear at the bottom of the
+// compiled file.
+//
+// Read Sprockets README (https://github.com/rails/sprockets#sprockets-directives) for details
+// about supported directives.
+//
+//= require_tree .

data/app/assets/stylesheets/support_utils/application.css

@@ -0,0 +1,15 @@
+/*
+ * This is a manifest file that'll be compiled into application.css, which will include all the files
+ * listed below.
+ *
+ * Any CSS and SCSS file within this directory, lib/assets/stylesheets, vendor/assets/stylesheets,
+ * or any plugin's vendor/assets/stylesheets directory can be referenced here using a relative path.
+ *
+ * You're free to add application-wide styles to this file and they'll appear at the bottom of the
+ * compiled file so the styles you add here take precedence over styles defined in any styles
+ * defined in the other CSS/SCSS files in this directory. It is generally better to create a new
+ * file per style scope.
+ *
+ *= require_tree .
+ *= require_self
+ */

data/app/controllers/support_utils/application_controller.rb

@@ -0,0 +1,4 @@
+module SupportUtils
+  class ApplicationController < ActionController::Base
+  end
+end

data/app/helpers/support_utils/application_helper.rb

@@ -0,0 +1,4 @@
+module SupportUtils
+  module ApplicationHelper
+  end
+end

data/app/views/layouts/support_utils/application.html.erb

@@ -0,0 +1,14 @@
+<!DOCTYPE html>
+<html>
+<head>
+  <title>SupportUtils</title>
+  <%= stylesheet_link_tag    "support_utils/application", media: "all" %>
+  <%= javascript_include_tag "support_utils/application" %>
+  <%= csrf_meta_tags %>
+</head>
+<body>
+
+<%= yield %>
+
+</body>
+</html>

data/config/routes.rb

@@ -0,0 +1,2 @@
+SupportUtils::Engine.routes.draw do
+end

data/lib/support_utils/all.rb

@@ -0,0 +1,5 @@
+require "rails"
+require "support_utils/concerns/core"
+require "support_utils/concerns/utils"
+
+require "support_utils/core/active_record/utils"

data/lib/support_utils/concerns/core.rb

@@ -0,0 +1,19 @@
+module SupportUtils
+  module Concerns
+    module Core
+      extend ActiveSupport::Concern
+
+      included do
+
+      end
+
+      module ClassMethods
+        def has_utils *args
+          options = args.extract_options!
+          include SupportUtils::Concerns::Utils
+        end
+      end
+
+    end
+  end
+end

data/lib/support_utils/concerns/utils.rb

@@ -0,0 +1,139 @@
+module SupportUtils
+  module Concerns
+    module Utils
+      extend ActiveSupport::Concern
+
+      included do
+
+        self.columns_hash.each do |column_name, metadata|
+          self.class_eval <<-RUBY
+
+            case
+            when  [:date, :datetime, :time, :timestamp].include?(metadata.type.to_s.to_sym)
+
+              def #{column_name}_format format = :default, *args
+                options = args.extract_options!
+                settings = HashWithIndifferentAccess.new({
+                  format: format
+                }).deep_merge(options)
+                I18n.l(self.#{column_name}, settings) if #{column_name}
+              end
+
+            when metadata.type == :integer
+
+              if metadata.limit.to_i == 1
+                def #{column_name}? *args
+                  self.#{column_name}.to_i.eql?(1)
+                end
+              end
+
+            when [:float, :decimal].include?(metadata.type.to_s.to_sym)
+
+              def #{column_name}_format *args
+                options = args.extract_options!
+                settings = HashWithIndifferentAccess.new({
+                  precision: 2
+                  }).deep_merge(options)
+                if settings[:currency].present?
+                  utils.h.number_to_currency self.#{column_name}, *[settings]
+                else
+                  utils.h.number_with_precision self.#{column_name}, *[settings]
+                end
+              end
+
+            when [:string, :text].include?(metadata.type.to_s.to_sym)
+
+                def #{column_name}_format *args, &block
+                  options = args.extract_options!
+                  case
+                  when options[:truncate].present?
+
+                    opts = options[:truncate].is_a?(Hash) ? options[:truncate] : {}
+                    utils.h.truncate self.#{column_name}.to_s, opts, &block
+
+                  when options[:word_wrap].present?
+
+                    opts = options[:word_wrap].is_a?(Hash) ? options[:word_wrap] : {}
+                    utils.h.word_wrap self.#{column_name}.to_s, opts, &block
+
+                  when options[:highlight].present?
+                    opts = options[:highlight].is_a?(Hash) ? options[:highlight] : {}
+                    phrases = (opts[:phrases].is_a?(Regexp) || opts[:phrases].is_a?(String) || opts[:phrases].is_a?(Array)) ? opts[:phrases] : ""
+                    utils.h.highlight self.#{column_name}.to_s,phrases, *opts.except(:phrases), &block
+
+                  when options[:excerpt].present?
+                    opts = options[:excerpt].is_a?(Hash) ? options[:excerpt] : {}
+                    phrase = (opts[:phrase].is_a?(Regexp) || opts[:phrase].is_a?(String) ) ? opts[:phrase] : ""
+                    utils.h.excerpt(self.#{column_name}.to_s,phrase, opts.except(:phrase), &block).to_s
+
+                  else
+                    html_options = options[:html_options] || {}
+                    utils.h.simple_format(self.#{column_name}, html_options.except(:html_options), options).to_s
+                  end
+                end
+
+            else
+
+              def #{column_name}_format *args
+                self.#{column_name}
+              end
+
+            end
+
+          RUBY
+        end
+
+
+      end
+
+      def update_attributes(attributes)
+        @saved = super
+      end
+
+      def save(*)
+        @saved = super
+      end
+
+      def saved?
+        @saved
+      end
+
+
+      def utils
+        @utils ||= SupportUtils::Core::ActiveRecord::Utils.new(self)
+      end
+
+
+      module ClassMethods
+
+        def truncate! confirm = false
+          adapter = ActiveRecord::Base.configurations[Rails.env]["adapter"]
+          adapter_method = :"truncate_#{adapter}!"
+          if confirm
+            if respond_to?(adapter_method, true)
+              send(adapter_method)
+            else
+              ActiveRecord::Base.connection.execute("TRUNCATE TABLE #{table_name.to_s}")
+            end
+          end
+        end
+
+        private
+
+        # SQLite doesn't have the "TRUNCATE TABLE" command
+        def truncate_sqlite3!
+          ActiveRecord::Base.connection.execute("DELETE FROM #{table_name.to_s}")
+          ActiveRecord::Base.connection.execute("DELETE FROM sqlite_sequence WHERE name='#{table_name.to_s}'")
+        end
+
+        # The "RESTART IDENTITY" Option will restart the primary key
+        def truncate_postgresql!
+          ActiveRecord::Base.connection.execute("TRUNCATE TABLE #{table_name.to_s} RESTART IDENTITY")
+        end
+
+
+      end
+
+    end
+  end
+end

data/lib/support_utils/core/active_record/utils.rb

@@ -0,0 +1,30 @@
+module SupportUtils
+  module Core
+    module ActiveRecord
+      class Utils
+
+        attr_reader :model
+
+        def initialize model
+          raise ArgumentError, ":model must be a subclass of ActiveRecord::Base" unless model.class < ::ActiveRecord::Base
+          @model = model
+        end
+
+        def time_zone
+          Time.zone
+        end
+
+        def helpers
+          ActionController::Base.helpers
+        end
+
+        alias_method :h, :helpers
+
+        def parse_time time
+          time_zone.parse(time) rescue nil
+        end
+
+      end
+    end
+  end
+end

data/lib/support_utils/engine.rb

@@ -0,0 +1,17 @@
+module SupportUtils
+  class Engine < ::Rails::Engine
+    isolate_namespace SupportUtils
+
+    config.after_initialize do
+      ActiveRecord::Base.send(:include, SupportUtils::Concerns::Core)
+    end
+
+    config.before_initialize do
+
+    end
+
+    config.to_prepare do
+    end
+
+  end
+end

data/lib/support_utils/version.rb

@@ -0,0 +1,3 @@
+module SupportUtils
+  VERSION = "0.1.0"
+end

data/lib/support_utils.rb

@@ -0,0 +1,5 @@
+require "support_utils/all"
+require "support_utils/engine"
+
+module SupportUtils
+end

data/lib/tasks/support_utils_tasks.rake

@@ -0,0 +1,4 @@
+# desc "Explaining what the task does"
+# task :support_utils do
+#   # Task goes here
+# end

data/test/dummy/README.rdoc

@@ -0,0 +1,28 @@
+== README
+
+This README would normally document whatever steps are necessary to get the
+application up and running.
+
+Things you may want to cover:
+
+* Ruby version
+
+* System dependencies
+
+* Configuration
+
+* Database creation
+
+* Database initialization
+
+* How to run the test suite
+
+* Services (job queues, cache servers, search engines, etc.)
+
+* Deployment instructions
+
+* ...
+
+
+Please feel free to use a different markup language if you do not plan to run
+<tt>rake doc:app</tt>.

data/test/dummy/Rakefile

@@ -0,0 +1,6 @@
+# Add your own tasks in files placed in lib/tasks ending in .rake,
+# for example lib/tasks/capistrano.rake, and they will automatically be available to Rake.
+
+require File.expand_path('../config/application', __FILE__)
+
+Rails.application.load_tasks

data/test/dummy/app/assets/javascripts/application.js

@@ -0,0 +1,13 @@
+// This is a manifest file that'll be compiled into application.js, which will include all the files
+// listed below.
+//
+// Any JavaScript/Coffee file within this directory, lib/assets/javascripts, vendor/assets/javascripts,
+// or any plugin's vendor/assets/javascripts directory can be referenced here using a relative path.
+//
+// It's not advisable to add code directly here, but if you do, it'll appear at the bottom of the
+// compiled file.
+//
+// Read Sprockets README (https://github.com/rails/sprockets#sprockets-directives) for details
+// about supported directives.
+//
+//= require_tree .

data/test/dummy/app/assets/javascripts/home.js

@@ -0,0 +1,2 @@
+// Place all the behaviors and hooks related to the matching controller here.
+// All this logic will automatically be available in application.js.

data/test/dummy/app/assets/stylesheets/application.css

@@ -0,0 +1,15 @@
+/*
+ * This is a manifest file that'll be compiled into application.css, which will include all the files
+ * listed below.
+ *
+ * Any CSS and SCSS file within this directory, lib/assets/stylesheets, vendor/assets/stylesheets,
+ * or any plugin's vendor/assets/stylesheets directory can be referenced here using a relative path.
+ *
+ * You're free to add application-wide styles to this file and they'll appear at the bottom of the
+ * compiled file so the styles you add here take precedence over styles defined in any styles
+ * defined in the other CSS/SCSS files in this directory. It is generally better to create a new
+ * file per style scope.
+ *
+ *= require_tree .
+ *= require_self
+ */

data/test/dummy/app/assets/stylesheets/home.css

@@ -0,0 +1,4 @@
+/*
+  Place all the styles related to the matching controller here.
+  They will automatically be included in application.css.
+*/