contracter 1.0.5 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: b32c9db01703d573151ddce123c0403746afa7e1
-  data.tar.gz: 788477762465d109407c983cd3faf77354f8e4ea
+  metadata.gz: 5e8ab75360b23d74f04742fffe810649c520bed5
+  data.tar.gz: 8ffb585e5114bbdf3c9b14ab5ff225b711fa209d
 SHA512:
-  metadata.gz: 64f3a1fa55628f59bad3d080778cd70a910ac44e34d47d4951d5faf7b3fcbe55f137a036ce40551a89a1434f87534a5ed6e2c4f8f1af0e783a07b7d3a4387b35
-  data.tar.gz: 54d3847f29a36a0d8d9a39bc6946d2f09cd9a1b3b390500256484e345006fee1be5e66eee198faae78d5b53f2334901bc9f1b5e996414769618db6ce5b16aee3
+  metadata.gz: 988d156e1a4552c2f8466aaee3f40c53d398e334982fc2cb4fd78bb1c4e99a7faa86deaf6b0ffc4a676c5100586c1ce9074fe346b5dc3afe9271b14c6080169c
+  data.tar.gz: 374c18db65abad1e2b919c63e4ad74f1417fd20264bec0982b2ca517fe38141d3d84eeb8b0ced7de5e0b15265c2165046e9afc1b19a795fa90772ae388f8f137

data/README.md

@@ -1,4 +1,4 @@
-# Contracter
+![contracter](assets/banner.png)
 
 Contracter is a quality of life gem that provides a simple Domain Specific Language for anyone to use in generating contracts for clients and services from templates. The default template is my personal contract template based on the popular open-source contract available [here](https://stuffandnonsense.co.uk/projects/contract-killer/).
 
@@ -26,22 +26,22 @@ First, require the gem:
 require 'contracter'
 ```
 
-Then generate a contract by using the Contracter DSL syntax:
+Then generate a contract by using the Contracter syntax:
 
 ```ruby
-contract = Contracter.build do
-    # Any property can be used here, and will get replaced with the given value in the template where the method name appears in the format [name].
-    company 'Test Company Please Ignore'
-
-    # Any property given multiple values will be replaced with the values on separate lines.
-    browsers 'Safari', 'Google Chrome'
+# This fills the default template
+contract = Contracter.build_from do
+    # Any property can be used here, and will get replaced with the given value in the template where the method name appears in the format [name]
+    test_value 'Test Value Please Ignore'
+end
 
-    # If you would like to use your own template, you may explicitly pass Contracter the path to it. The template can be in any plain text UTF-8 encoded format.
-    template_path 'path/to/your/template.txt'
+# You can also fill a custom template, by passing Contracter the path
+contract = Contracter.build_from 'path/to/custom/template' do
+    test_value 'Test Value Please Ignore'
 end
 ```
 
-The contract will be built from the template and returned as a Markdown-formatted string.
+The contract will be built from the template and returned as a string.
 
 ## Development
 

data/lib/contracter.rb

@@ -1,19 +1,12 @@
-require "contracter/contract"
+Dir["#{File.dirname(__FILE__)}/contracter/**/*.rb"].each { |e| require e unless e == 'version.rb' }
 
 class Contracter
-    def self.build &block
-        c = Contract.new
+    def self.build_from(path = "#{File.expand_path('..', File.dirname(__FILE__))}/data/contracter/template.md", &block)
+        c = Contract.new File.read(path, :encoding => "UTF-8")
+        c.load_params
         c.instance_eval(&block)
+        c.replace_params
 
-        t = (c.instance_variable_get("@template_path") or "#{Gem.datadir('contracter')}/template.md")
-        self.fill_template(File.read(t, :encoding => "UTF-8"), c)
-    end
-
-private
-    def self.fill_template t, c
-        c.instance_variables.map(&:to_s).each do |v|
-            t.gsub!(/\[#{Regexp.quote(v.gsub("@", ""))}\]/, c.instance_variable_get(v))
-        end
-        t.gsub(/\[\w+?\]/, "MISSING")
+        c.template
     end
 end

data/lib/contracter/contract.rb

@@ -1,15 +1,26 @@
 class Contract
-    def method_missing(name_sym, *args)
-        if args.length == 1
-            self.instance_variable_set "@#{name_sym.to_s}", *args
-        elsif args.length > 1
-            self.instance_variable_set "@#{name_sym.to_s}", args.join('\n')
-        else
-            raise ArgumentError, 'Value not passed to template.'
-        end
-    end
-
-    def template_path p
-        @template_path = p
+    attr_accessor :template
+
+    def params
+        @params ||= Hash.new
+    end
+
+    def initialize p
+        @template = p
+    end
+
+    def method_missing(method_sym, *args)
+        raise ContractError, "Cannot find [#{method_sym}] in template." unless self.params.has_key?(method_sym)
+        raise ContractError, "Must provide only one value for [#{method_sym}]." unless args.length == 1
+        self.params[method_sym] = args.first
+    end
+
+    def load_params
+        self.template.scan(/\[(\w+?)\]/).flatten.each { |p| self.params[p.to_sym] = nil }
+    end
+
+    def replace_params
+        raise ContractError, "Missing values for #{self.params.select { |k, v| v.nil? }.keys.map { |e| "[#{e}]"}.join ', '}." if self.params.has_value? nil
+        self.params.each { |k, v| self.template.gsub!(/\[#{Regexp.quote(k.to_s)}\]/, v) }
     end
 end

data/lib/contracter/errors/contracterror.rb

@@ -0,0 +1,2 @@
+class ContractError < StandardError
+end

data/lib/contracter/version.rb

@@ -1,3 +1,3 @@
 class Contracter
-  VERSION = "1.0.5"
+  VERSION = "1.1.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: contracter
 version: !ruby/object:Gem::Version
-  version: 1.0.5
+  version: 1.1.0
 platform: ruby
 authors:
 - Remi Gelinas
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2015-12-09 00:00:00.000000000 Z
+date: 2015-12-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -65,12 +65,15 @@ files:
 - Gemfile
 - README.md
 - Rakefile
+- assets/banner.png
+- assets/banner.xcf
 - bin/console
 - bin/setup
 - contracter.gemspec
 - data/contracter/template.md
 - lib/contracter.rb
 - lib/contracter/contract.rb
+- lib/contracter/errors/contracterror.rb
 - lib/contracter/version.rb
 homepage: https://github.com/remi-gelinas/contracter
 licenses: []
@@ -91,7 +94,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.5.1
+rubygems_version: 2.5.1
 signing_key: 
 specification_version: 4
 summary: A quality of life gem for templated contract generation.