duffy 0.0.7 → 0.0.8

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: d2c0c79fd0c66096e43aabbb8f14e8270a059369
-  data.tar.gz: 622727f32c423cdbc15f5105f93c7097fc8f7d9c
+  metadata.gz: 361bbe6eab3ff805b7cb85505c2eaa7454288060
+  data.tar.gz: 3898b205ab16a15c0650c2114ac5ddee28b69d43
 SHA512:
-  metadata.gz: 0c347b65e761f2073ac863772a9a6d83c9dd9bab1ee53ff9eb0d56b4fa5cfceb34f56cc89f131c67a4e6a8ce162dd697ee7fe4492aec508536862bd68766fdc8
-  data.tar.gz: 88ad7895de82a7e4cc6a85d1770822bf466ecac9deff6b81b8be2805867dee410f26458762d1e1dd05a45674b7274f4c5ee13124c17531d06094d2682dc41f31
+  metadata.gz: e1dae822379c3e5093f64b02918624bce7fb1dea26bc8879f3904c78c2e5b7924103fa1413b8dbbfcd76bbf100aa5d177360a81025825812272b52fff92da226
+  data.tar.gz: c15affda9804b108a6de7e1236b8c774a8e91a4f4f435d5f19f7a150eeb350d4535a0b506813c4c20312cd3ac0e57a670f6642f6fac6b0220e1ab13f7f659175

data/README.md

@@ -1,10 +1,11 @@
 # Duffy
 
-TODO: Write a gem description
+This is a collection of reusable things I don't want to keep duplicating in tons of projects.
 
 ## Installation
 
 Add this line to your application's Gemfile:
+* This is a work in progress.  If someone decides to use this, you may want to lock your version number in your gemfile.
 
 ```ruby
 gem 'duffy'
@@ -14,13 +15,36 @@ And then execute:
 
     $ bundle
 
-Or install it yourself as:
+## Usage
 
-    $ gem install duffy
+String Patches:
+```ruby
+    to_ssn
+    to_numeric
+    to_alpha
+    to_alpha_numeric
+    pretty_phone
+    pretty_committer    # TODO: Setup gem configuration to load patterns
+    space2nbsp
+    nl2br
+    gender_human
+    smart_titlecase     # Note: Has config options. See lib/duffy.rb
+```
 
-## Usage
+Git Access:
+This one is namespaced incase you use the 'git' gem.  I found it to be overkill for what I wanted.
+```ruby
+    Duffy::Git.log      # => Produce tab separated listing of current git log.
+    Duffy::Git.count    # => Count of git commits in current branch
+```
 
-TODO: Write usage instructions here
+View Helpers:
+This is a work in progress.  I'm going to try to put all my generic helpers here.
+```ruby
+    menu_tag
+    excel_icon
+    icon
+```
 
 ## Contributing
 

data/lib/duffy/duffy_helper.rb

@@ -1,32 +1,38 @@
 module DuffyHelper
 
-  def menu_tag( title, link, options = {})
-    link_to(content_tag(:li, title, options), link)
+  # This creates menu entries in the format Zurb Foundation expects.
+  # It's just an <li> with a link inside it.
+  # menu_tag('Help', help_path)   =>  <li><a href="/help">Help</a></li>
+  def menu_tag(title, link, options = {})
+    content_tag(:li, link_to(title, link), options)
   end
 
-  def excel_icon(link = params.merge(:format => "xlsx"))
-    # Create Excel icon in consistent location
+  # Create Excel icon in consistent location
+  # This is intended to display the xlsx version of a view.
+  # Add a yield(:excel) somewhere in your application layout:
+  #   content_tag( :li, yield(:excel), class: :excel) if content_for?(:excel)
+  def excel_icon(link = params.merge(format: "xlsx"))
     content_for :excel do
-      link_to(image_tag('excel.png', :width => 40, :height => 40), link)
+      link_to(image_tag('excel.png'), link)
     end
   end
 
+  # Create a simple link with the class "icon"
+  # Generate a uniq and reasonable id based on the link passed (if any)
+  # Add any classes passed in via options
+  # Add the "favorite" class if icon is favorited
+  #  - This is application specific and will just not do anything if it runs into a problem
+  # If any uncaught exceptions are thrown in production you'll just get nothing, otherwise you'll get the error on screen.
   def icon(title, link, options = {})
     begin
-      options[:id]    = "icon_#{link.parameterize("_")}"
+      options[:id]    = "icon_#{link.parameterize("_")}" unless link.blank?
       options[:class] = [:icon] << options[:class]
-      options[:class] << "favorite" if defined?(current_user) and (current_user.person.details.where(key: "favorite_#{options[:id]}").any? rescue false)
+      options[:class] << :favorite if defined?(current_user) and (current_user.person.details.where(key: "favorite_#{options[:id]}").any? rescue false)
+      options[:class] = options[:class].flatten.compact
       link_to(title, link, options)
     rescue Exception => e
       Rails.env.development? ? content_tag(:p, e) : nil
     end
   end
 
-
-
-
-
-
-
-
 end

data/lib/duffy/string.rb

@@ -57,14 +57,10 @@ class String
   end
 
   # Parse a git username into a friendly name
+  # Expects committers to be a hash in this format:  { jpd" => "Jacob", /ers|Eric/ => "Eric" }
+  # All String keys are converted to Regex, explicit Regex is fine too.
   def pretty_committer
-    case self
-      when /jpd/      then "Jacob"
-      when /ers|Eric/ then "Eric"
-      when /gac/      then "Glenn"
-      when /jes/      then "Samsky"
-      else self
-    end
+    Hash(Duffy.configuration.committers).map{|k,v| v if Regexp.new(k) =~ self}.compact.first or self
   end
 
   def space2nbsp
@@ -125,9 +121,11 @@ class String
     end #each
 
     # Special Cases:
+    upcase_re = (Array(Duffy.configuration.upcase_custom) + Array(Duffy.configuration.upcase_default)).uniq.join("|")
+
     result.gsub!(/ V(s?)\. /, ' v\1. ') # "v." and "vs."
     result.gsub!(/([''])S\b/, '\1s') # 'S (otherwise you get "the SEC'S decision")
-    result.gsub!(/\b(AOB|AT&T|Q&A|II|III|IV|HR|CT|CHS|CME|DFM|HRS|PA|UDDS|USA|UWMF|WREN)\b/i) { |w| w.upcase } # "AT&T" and "Q&A", which get tripped up by
+    result.gsub!(/\b(#{upcase_re})\b/i) { |w| w.upcase } unless upcase_re.blank?
     result
   end
 end

data/lib/duffy/version.rb

@@ -1,3 +1,3 @@
 module Duffy
-  VERSION = "0.0.7"
+  VERSION = "0.0.8"
 end

data/lib/duffy.rb

@@ -13,4 +13,38 @@ require File.dirname(__FILE__) + "/duffy/railtie" if defined?(Rails)
 module Duffy
   class Engine < Rails::Engine
   end
-end
+
+  def self.configuration
+    @configuration ||= Duffy::Configuration.new
+  end
+
+  def self.configure
+    yield configuration
+  end
+
+  # Override any duffy defaults conveniently with config options
+  # example:
+  # [config/initializers/duffy.rb]
+  # Duffy.configure do |config|
+  #   config.upcase_custom = %w(AOB CHS CME CT DFM HRS PA UDDS UWMF WREN)
+  # end
+  #
+  class Configuration
+    include ActiveSupport::Configurable
+
+    # Smart Titlecase
+    # Use :update_custom to add uppercase special cases
+    # Use :update_default to replace my defaults
+    config_accessor(:upcase_custom)     # {%w(NBC CNN FOO)}
+    config_accessor(:upcase_default)    {%w(HR II III IV Q&A USA)}
+
+    # Pretty Committer
+    config_accessor(:committers)        # {"jpd" => "Jacob", "ers|Eric" => "Eric"}
+
+  end
+
+
+end
+
+
+

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: duffy
 version: !ruby/object:Gem::Version
-  version: 0.0.7
+  version: 0.0.8
 platform: ruby
 authors:
 - Jacob Duffy
@@ -96,7 +96,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.2
+rubygems_version: 2.4.3
 signing_key: 
 specification_version: 4
 summary: Library of things