submarine 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 35a13bbaed8ceffacdcd6e3f96916dca97245ad0
+  data.tar.gz: 22222a0a7ac87624c64afc8fd100e3c222fb0710
+SHA512:
+  metadata.gz: faeb1a6de9fc7b1264b3dc067e7e936a1084e37c17d42ee2120452a2cd9a33c7a0415763b887fd06740fdd3a3b6e4ef58e5d46ecc38000dfd5cba9b0b1ceb89d
+  data.tar.gz: 8998375b0f98303823a2ad9aace1645c690357d2f3dbcbe38cd18dbf7b5deee85d7a8d85e8693d2a4ff0e4e393861d0d6c270eaf0fe5be5d9a6b61caafcda514

data/lib/submarine.rb

@@ -0,0 +1,5 @@
+require 'facets/hash/symbolize_keys'
+
+require File.dirname(__FILE__) + '/submarine/submarine'
+require File.dirname(__FILE__) + '/submarine/exceptions'
+require File.dirname(__FILE__) + '/submarine/configuration'

data/lib/submarine/configuration.rb

@@ -0,0 +1,43 @@
+class Submarine::Configuration
+
+  # Acceptable accessors.
+  attr_accessor :format_key, :left_delimeter, :right_delimeter, :substitutions
+
+  # Constructs a new Configuration instance.
+  # Merges passed in options hash, sets instance variables.
+  #
+  def initialize *attrs
+    options = attrs.empty? ? {} : attrs.first
+    options = self.class.defaults.merge(options)
+    set_instance_variables options
+  end
+
+  # Configuration defaults.
+  #
+  def self.defaults
+    {
+      format_key:      :text, # The key representing the string to be formatted
+      left_delimeter:  '[[',  # The left-side matching string, ie: '[[name]]'
+      right_delimeter: ']]',  # The right-side matching string, ie: '[[name]]'
+      substitutions:   {}     # Optional global default substitutions 
+    }
+  end
+
+  # Reload the Configuration instance variables to defaults.
+  #
+  def reload!
+    set_instance_variables(self.class.defaults)
+  end
+
+private
+
+  # Set the instance variables from passed in options hash.
+  #
+  def set_instance_variables options
+    @format_key      = options[:format_key].to_sym
+    @left_delimeter  = options[:left_delimeter].to_s
+    @right_delimeter = options[:right_delimeter].to_s
+    @substitutions   = options[:substitutions]
+  end
+
+end

data/lib/submarine/exceptions.rb

@@ -0,0 +1,19 @@
+class Submarine
+
+  # If no attributes are sent to Submarine.new, throw this.
+  #
+  class MissingAttributesError < StandardError
+    def initialize(message = 'No attributes provided')
+      super(message)
+    end
+  end
+
+  # If no :format_key is sent to Submarine.new, throw this.
+  #
+  class MissingFormatKeyError < StandardError
+    def initialize(message = 'No format key provided')
+      super(message)
+    end
+  end
+
+end

data/lib/submarine/submarine.rb

@@ -0,0 +1,141 @@
+class Submarine
+
+  # Constructs a new Submarine instance.
+  # Set instance variable and readers based on input hash.
+  #
+  def initialize *attrs
+    raise MissingAttributesError unless attrs_provided?(attrs)
+    raise MissingFormatKeyError unless attrs_includes_format_key?(attrs)
+
+    attrs = attrs.first.merge(config.substitutions) # merge Configuration defaults
+
+    attrs.each do |key, value|
+      self.instance_variable_set("@#{key}", value) 
+      self.class.class_eval{attr_reader key}
+    end
+  end
+
+  # Destructively format the Submarine instance.
+  # Returns the formatted string.
+  #
+  # Example:
+  #   >> sub = Submarine.new(text: 'Hello, my name is [[name]].', name: 'Joe')
+  #   => #<Submarine @text="Hello, my name is [[name]].", @name="Joe">
+  #   >> sub.format!
+  #   => "Hello, my name is Joe."
+  #   >> sub
+  #   => #<Submarine @text="Hello, my name is Joe.", @name="Joe">
+  #
+  # And, obviously, one line makes it more succinct:
+  #   >> Submarine.new(text: 'Hello, my name is [[name]].', name: 'Joe').format!
+  #   => "Hello, my name is Joe."
+  #
+  def format!
+    substitutions.each{|s| sub_string.gsub!(match(s), replace(s))}
+    sub_string
+  end
+
+  class << self
+    # Global Submarine configuration getter.
+    # Returns the current configuration options.
+    # 
+    # Example:
+    #   >> Submarine.config
+    #   => #<Submarine::Configuration @format_key=:text, @left_delimeter="[[", @right_delimeter="]]", @substitutions={}> 
+    #
+    def config
+      @config ||= Configuration.new
+    end
+
+    # Global Submarine configuration setter.
+    # The global default Submarine::Configuration options can be overwritten
+    # by passing a block to config and setting new options.
+    #
+    # Example:
+    #  # config/initializers/submarine.rb  <-- if you're using Rails, say
+    #  Submarine.configure do |config|
+    #    config.format_key = :copy
+    #    config.left_delimeter = '<^'
+    #    config.right_delimeter = '^>'
+    #    config.substitutions = {company: 'Submarine Inc, Co'}
+    #  end
+    #
+    #  >> Submarine.config
+    #  => #<Submarine::Configuration @format_key=:copy, @left_delimeter="<^", @right_delimeter="^>", @substitutions={company: 'Submarine Inc, Co'}>
+    # 
+    def configure
+      yield config
+    end
+  end
+
+private
+
+  # Were any attributes passed to Submarine.new?
+  #
+  def attrs_provided? attrs
+    !attrs.empty?
+  end
+
+  # Was the :format_key attribute passed to Submarine.new?
+  #
+  def attrs_includes_format_key? attrs
+    attrs.first.symbolize_keys.keys.include?(config.format_key.to_sym)
+  end
+
+  # Returns the string to be formatted.
+  #
+  # Example: 
+  #   >> sub = Submarine.new(text: 'Format this string!')
+  #   >> sub.send(:sub_string)
+  #   => "Format this string!"
+  #
+  def sub_string
+    instance_variable_get("@#{config.format_key}")
+  end
+
+  # Returns the string to match for gsub with passed in key.
+  #
+  # Example:
+  #   >> sub = Submarine.new(text: 'Hello, my name is [[name]].', name: 'Joe')
+  #   >> sub.send(:match, :name)
+  #   => "[[name]]"
+  #
+  def match key
+    "#{config.left_delimeter}#{key}#{config.right_delimeter}"
+  end
+
+  # Returns the replacement for gsub with passed in key.
+  #
+  # Example:
+  #   >> sub = Submarine.new(text: 'Hello, my name is [[name]].', name: 'Joe')
+  #   >> sub.send(:replace, :name)
+  #   => "Joe"
+  def replace key
+    instance_variable_get("@#{key}").to_s
+  end
+
+  # Returns the global Submarine config.
+  #
+  # Example: 
+  #   >> sub = Submarine.new(text: 'Hello, my name is [[name]].', name: 'Joe')
+  #   >> sub.send(:config)
+  #   => #<Submarine::Configuration @format_key=:text, @left_delimeter="[[", @right_delimeter="]]", @substitutions={}>
+  #
+  def config
+    self.class.config
+  end
+
+  # Returns an array of symbols to use for matching.
+  #
+  # Example:
+  #   >> sub = Submarine.new(text: 'Hello, my name is [[name]].', name: 'Joe')
+  #   >> sub.send(:substitutions)
+  #   => [:text, :name]
+  #
+  def substitutions
+    subs = self.instance_variables
+    subs.delete(config.format_key)
+    subs.map{|s| s.to_s.gsub('@', '').to_sym}
+  end
+
+end

metadata

@@ -0,0 +1,90 @@
+--- !ruby/object:Gem::Specification
+name: submarine
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Caleb K Matthiesen
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-10-05 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: facets
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.9.3
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.9.3
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.3'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 5.4.2
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 5.4.2
+description: A lightweight string formatter.
+email: c@calebkm.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/submarine.rb
+- lib/submarine/configuration.rb
+- lib/submarine/exceptions.rb
+- lib/submarine/submarine.rb
+homepage: http://www.submarine-gem.org
+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.2.2
+signing_key: 
+specification_version: 4
+summary: Deep sea string substitution.
+test_files: []
+has_rdoc: