heroics 0.0.18 → 0.0.19

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 179b0e5aaa24933d18882a76ec0959fa652daaf0
-  data.tar.gz: cc6aa87e66ff2668dea1564bcc618734f0b4759f
+  metadata.gz: 6ad986af06425a0794b57a5ed51f9ff9ff4f3c59
+  data.tar.gz: 355d94f757b2820464f5b65ceec411061665e378
 SHA512:
-  metadata.gz: e9bc244a410cf64600f6dfe4bf6f7c07e23aed919586383f9a9cc30f8f543beb48c3adee94a535fe6d810fad376677a6269da86512611a2e2c35ea498e208c65
-  data.tar.gz: 8be7d88e12c9fe28174e4d1ae9854de0f9f04631025155e6243f2ef8a6dc9c07d02b7783ecba849e359414a34431f2d491b2e6ca7fe3219102414b1199f009f4
+  metadata.gz: f4ae1365bdacbde7816d0cb5091c0c25c4ca803da9709a55b77f5313b54e18c59cc0b8b619e6fc17832dcd473ffe729a906b71f94d2bfd62159cb41c5c1fe69d
+  data.tar.gz: 82b7611b2e33cca630ab2d2b39d996cc4a8c942e0195a0cf850258028e848b740c3eb98a4020dcec35248a556c870e27cbe817227eace57bde65a047b1b0f4ba

data/README.md

@@ -40,7 +40,14 @@ end
 
 #### Optional configuration
 
-`config.headers` and `config.cache_path` are optional, but all other config shown above is required.
+`base_url`, `module_name`, and `schema_filepath` are required for a proper configuration.
+
+The following keys are optional:
+
+* `headers`
+* `cache_path`
+* `ruby_name_replacements` a hash of replacement patterns for converting endpoint paths to Ruby method names, such as:
+> { /[\s-]+/ => '_' }
 
 For further details on config file usage, see the `example/` directory in this repo.
 

data/lib/heroics/configuration.rb

@@ -3,17 +3,28 @@
 module Heroics
   # Attempts to load configuration, provides defaults, and provide helpers to access that data
   class Configuration
-    attr_reader :base_url, :cache_path, :module_name, :schema, :options
+    attr_reader :base_url,
+      :cache_path,
+      :module_name,
+      :schema,
+      :ruby_name_replacement_patterns,
+      :options
 
     def self.defaults
       @defaults ||= Configuration.new
     end
 
+    def self.restore_defaults
+      @defaults = Configuration.new
+    end
+
     def initialize
       @options = {}
       @options[:cache] = 'Moneta.new(:Memory)'
       @options[:default_headers] = {}
 
+      @ruby_name_replacement_patterns = { /[\s-]+/ => '_' }
+
       yield self if block_given?
     end
 
@@ -41,5 +52,10 @@ module Heroics
       raise "Must provide a hash of headers" unless headers.is_a?(Hash)
       @options[:default_headers] = headers
     end
+
+    def ruby_name_replacement_patterns=(patterns)
+      raise "Must provide a hash of replacements" unless patterns.is_a?(Hash)
+      @ruby_name_replacement_patterns = patterns
+    end
   end
 end

data/lib/heroics/naming.rb

@@ -3,10 +3,19 @@ module Heroics
   # Process a name to make it suitable for use as a Ruby method name.
   #
   # @param name [String] The name to process.
-  # @return [String] The new name with capitals converted to lowercase, and
-  #   dashes and spaces converted to underscores.
+  # @return [String] The new name with capitals converted to lowercase,
+  #   and characters replaced or removed based on the
+  #   Configuration.ruby_names_replacement_patterns rules
+  # @raise [SchemaError] Raised if the name contains invalid characters.
   def self.ruby_name(name)
-    name.downcase.gsub(/[- ]/, '_')
+    patterns = Heroics::Configuration.defaults.ruby_name_replacement_patterns
+
+    ruby_name = patterns.reduce(name.downcase) do |memo, (regex, replacement)|
+      memo.gsub(regex, replacement)
+    end
+
+    raise SchemaError.new("Name '#{name}' converts to invalid Ruby name '#{ruby_name}'.") if ruby_name =~ /\W/
+    ruby_name
   end
 
   # Process a name to make it suitable for use as a pretty command name.

data/lib/heroics/version.rb

@@ -1,4 +1,4 @@
 # frozen_string_literal: true
 module Heroics
-  VERSION = '0.0.18'
+  VERSION = '0.0.19'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: heroics
 version: !ruby/object:Gem::Version
-  version: 0.0.18
+  version: 0.0.19
 platform: ruby
 authors:
 - geemus
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-02-14 00:00:00.000000000 Z
+date: 2017-02-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler