contracter 0.1.4 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: d607ea87aceaf13c53689815fd6157e1985416d3
-  data.tar.gz: d5c04a6a815b00610aa5782bf653effe39646b14
+  metadata.gz: 36c1c3116c3dc286061c63edb7d9f64dd12686a1
+  data.tar.gz: fc522b7122d790e0f72f3cdc1490dcc1c7000251
 SHA512:
-  metadata.gz: 98a5f14b78cd4afeebeab388c9d67800c006e1102890696204ed8fc84d1dbb3956822c6f31ed20eae2bfcdd9e2e706aaa9a8e6813935242192b101aec04363d1
-  data.tar.gz: 75bc274a34226a60a4b3471fc72a374a3650a3e5c5bd0bd5ed1418c68b8bd942c1bf62caa1f0edf4fa81fb1555768b251bb3e12b93bd9cc4deb7ef07e2a7da19
+  metadata.gz: 3179351c5d8c3b48f246c54f632a5053995f67603b08a5c4c97b7f4e2d9a4b7dc4e5bb120f3eca882798a281489af602d1e8985914830311be987962cff95d37
+  data.tar.gz: c369201cd81b6891edf99dcafcd65ee1b5b156261c1863cc3267f306217416f402ae4bdb1faf4c4fe726a6a0df58b64eda556a0fb49a4d818e7eb9c784a50c55

data/README.md

@@ -1,8 +1,6 @@
 # Contracter
 
-Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/contracter`. To experiment with that code, run `bin/console` for an interactive prompt.
-
-TODO: Delete this and the text above, and describe your gem
+Contracter is a quality of life gem that provides a simple Domain Specific Language for web designers and developers to use in generating their client contracts. Contracts are generated in a Markdown format and are based on the popular open-source contract available [here](https://stuffandnonsense.co.uk/projects/contract-killer/).
 
 ## Installation
 
@@ -22,7 +20,28 @@ Or install it yourself as:
 
 ## Usage
 
-TODO: Write usage instructions here
+First, require the gem:
+
+```ruby
+require 'contracter'
+```
+
+Then generate a contract by using the Contracter DSL 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'
+
+    # 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'
+end
+```
+
+The contract will be built from the template and returned as a Markdown-formatted string.
 
 ## Development
 
@@ -32,5 +51,4 @@ To install this gem onto your local machine, run `bundle exec rake install`. To
 
 ## Contributing
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/contracter.
-
+Bug reports and pull requests are welcome on GitHub at https://github.com/remi-gelinas/contracter.

data/data/contracter/template.md

@@ -43,16 +43,19 @@ Browser testing no longer means attempting to make a website look the same in br
 
 ### Desktop browser testing
 
-I test my work in current versions of major desktop browsers including those made by Apple (Safari), Google (Chrome), Microsoft (Edge), Mozilla Firefox and Opera. I'll also test to ensure that people who use Microsoft Internet Explorer 11 for Windows get an appropriate experience. I won’t test in other older browsers unless I agreed separately. If you need an enhanced design for an older browser, I can provide a separate estimate for that.
+I test my work in current versions of major desktop browsers including:
+
+[desktop_browsers]
+
+I won’t test in other older browsers unless I agreed separately. If you need an enhanced design for an older browser, I can provide a separate estimate for that.
 
 ### Mobile browser testing
 
 Testing using popular smaller screen devices is essential in ensuring that a person’s experience of a design is appropriate to the capabilities of the device they’re using. I test my designs in:
 
-Google Chrome
-Android: Google Chrome on Android Emulator
+[mobile_browsers]
 
-I won’t test in Blackberry, Opera Mini/Mobile, specific Android devices, Windows or other mobile browsers unless agreed separately.
+I won’t test in other mobile browsers unless agreed upon separately.
 
 ### Technical support
 
@@ -65,8 +68,7 @@ I don’t guarantee improvements to your website's search engine ranking, but th
 
 ### Changes and revisions
 
-I know from experience that fixed-price contracts are rarely beneficial to you, as they often limit you to your earliest ideas. I don’t want to limit your ability to change your mind. The price at the beginning of this contract is based on the
-number of weeks that I estimate I'll need to accomplish everything you’ve told me you want to achieve, but I’m happy to be flexible. If you want to change your mind or add anything new, that won’t be a problem as I'll provide a separate estimate for those additional weeks.
+I know from experience that fixed-price contracts are rarely beneficial to you, as they often limit you to your earliest ideas. I don’t want to limit your ability to change your mind. The price at the beginning of this contract is based on the number of weeks that I estimate I'll need to accomplish everything you’ve told me you want to achieve, but I’m happy to be flexible. If you want to change your mind or add anything new, that won’t be a problem as I'll provide a separate estimate for those additional weeks.
 
 ### Legal stuff
 
@@ -74,7 +76,7 @@ I can’t guarantee that my work will be error-free and so I can’t be liable t
 
 ### Copyrights
 
-First, you guarantee that all elements of text, images or other artwork you provide are either owned by your good selves, or that you’ve permission to use them.
+First, you guarantee that all elements of text, images or other artwork you provide are either owned by you, or that you’ve permission to use them.
 
 Then, when your final payment has cleared, copyright will be automatically assigned as follows:
 
@@ -102,7 +104,7 @@ You agree to pay all charges associated with international transfers of funds. T
 
 Just like a parking ticket, you can’t transfer this contract to anyone else without my permission. This contract stays in place and need not be renewed. If for some reason one part of this contract becomes invalid or unenforceable, the remaining parts of it remain in place.
 
-Although the language is simple, the intentions are serious and this contract is a legal document under exclusive jurisdiction of [English and Welsh] courts.
+Although the language is simple, the intentions are serious and this contract is a legal document under exclusive jurisdiction of [court] courts.
 
 ### The dotted line
 

data/lib/contracter/contract.rb

@@ -1,34 +1,12 @@
 class Contract
-    def company c
-        @company = c
-    end
-
-    def client c
-        @client = c
-    end
-
-    def client_address a
-        @client_address = a
-    end
-
-    def service s
-        @service = s
-    end
-
-    def estimated_total t
-        @estimated_total = t
-    end
-
-    def payment_details d
-        @payment_details = d
-    end
-
-    def payment_schedule s
-        @payment_schedule = s
-    end
-
-    def date d
-        @date = d
+    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

data/lib/contracter/version.rb

@@ -1,3 +1,3 @@
 class Contracter
-  VERSION = "0.1.4"
+  VERSION = "1.0.0"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: contracter
 version: !ruby/object:Gem::Version
-  version: 0.1.4
+  version: 1.0.0
 platform: ruby
 authors:
 - Remi Gelinas