contracter 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: ee7ca5e3dd4c8fbc12a97e53308bb106f0a48e47
+  data.tar.gz: 0d5b58aed111486e9242cb383b413d5442c08c10
+SHA512:
+  metadata.gz: 111fc80dbc288039c2af3a26db2a081fbe2ca066f02f986411fc744c4778ce38e020eae043a0ee4f540e226b9616ea9665b6881fa063299c5fb544a7754236bd
+  data.tar.gz: f93ffec17804a33ca882e66d64e8b4a18bfde151230c07599f55c4e9d8fdfcf71ca1345af8169b01d1af1ecaac871a81fea52a7ae924040bf26a5a2d7b5e23d2

data/.gitignore

@@ -0,0 +1,9 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in contracter.gemspec
+gemspec

data/README.md

@@ -0,0 +1,36 @@
+# 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
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'contracter'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install contracter
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/contracter.
+

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "contracter"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start

data/bin/setup

@@ -0,0 +1,7 @@
+#!/bin/bash
+set -euo pipefail
+IFS=$'\n\t'
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/contracter.gemspec

@@ -0,0 +1,24 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'contracter/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "contracter"
+  spec.version       = Contracter::VERSION
+  spec.authors       = ["Remi Gelinas"]
+  spec.email         = ["remigelinas1@gmail.com"]
+
+  spec.summary       = %q{A web development contract generator.}
+  spec.description   = %q{A Ruby gem that provides a simple DSL for generating web development contracts.}
+  spec.homepage      = "https://github.com/remi-gelinas/contracter"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.10"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec"
+end

data/lib/contracter/contract.rb

@@ -0,0 +1,37 @@
+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
+    end
+
+    def template_path p
+        @template_path = p
+    end
+end

data/lib/contracter/template.md

@@ -0,0 +1,111 @@
+
+
+Between me ([company])
+and you ([client])
+
+## Summary:
+
+I'll always do my best to fulfill your needs and meet your expectations, but it’s important to have things written down so that we both know what’s what, who should do what and when, and what will happen if something goes wrong. In this contract you won’t find any complicated legal terms or long passages of unreadable text. I’ve no desire to trick you into signing something that you might later regret. What I do want is what’s best for both parties, now and in the future.
+
+So in short;
+
+You ([client]), located at [client_address] are hiring me ([company]) located at [company_address] to [service] for the estimated total price of[estimated_total] as outlined in my previous correspondence. Of course it’s a little more complicated, but I'll get to that.
+
+## What do both parties agree to do?
+
+*You:* You have the authority to enter into this contract on behalf of yourself, your company or your organization. You’ll give me the assets and information I tell you I need to complete the project. You’ll do this when I ask and provide it in the formats I need. You’ll review my work, and provide feedback and approval in a timely manner too. Deadlines work two ways, so you’ll also be bound by dates we set together. You also agree to stick to the payment schedule set out at the end of this contract.
+
+*Me:* I have the experience and ability to do everything I’ve agreed with you and I'll do it all in a professional and timely manner. I'll endeavor to meet every deadline that’s set and on top of that I'll maintain the confidentiality of everything you give me.
+
+## Getting down to the nitty gritty
+
+### Design
+
+I create look-and-feel designs, and flexible layouts that can adapt to the capabilities of many devices and screen sizes. I create designs iteratively and use predominantly HTML and CSS so I won’t waste time mocking up every template as a static visual. I may use visuals to indicate a creative direction (colour, texture and typography.) I call that ‘atmosphere.’
+
+You’ll have plenty of opportunities to review my work and provide feedback. I'll either share a Dropbox folder or Github repository with you and I'll endeavor to maintain regular contact. If, at any stage, you’re not happy with the direction my work is taking, you’ll pay me in full for everything I’ve produced until that point and cancel this contract.
+
+### Text content
+
+Unless agreed separately, I’m not responsible for inputting text or images into your content management system. If you’d like me to create new content or input for you, I can provide a separate estimate for that.
+
+### Graphics and photographs
+
+You should supply graphic files in an editable, vector digital format. You should supply photographs in a high resolution digital format.
+
+### Architecture
+
+I deliver web pages using HTML markup and CSS stylesheets for styling, and Javascript for communication with the back-end. I deliver web applications using a predominantly Ruby on Rails back-end connected to a PostgreSQL database, with a predominantly React.js front-end.
+
+### Browser testing
+
+Browser testing no longer means attempting to make a website look the same in browsers of different capabilities or on devices with different size screens. It does mean ensuring that a person’s experience of a design should be appropriate to the capabilities of a browser or device.
+
+### 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.
+
+### 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
+
+I won’t test in Blackberry, Opera Mini/Mobile, specific Android devices, Windows or other mobile browsers unless agreed separately.
+
+### Technical support
+
+I’m not a website hosting company so I don’t offer support for website hosting, email or other services relating to hosting. You may already have professional hosting and you might even manage that hosting in-home; if you do, great. If you don’t, I can set up an account for you at one of my preferred hosting providers. I can set up your site on a server, plus any statistics software such as Google Analytics, and I can provide a separate estimate for that. Then, the updates to, and management of that server will be up to you, unless we agree
+separately.
+
+### Search engine optimization (SEO)
+
+I don’t guarantee improvements to your website's search engine ranking, but the web pages that I develop are accessible to search engines.
+
+### 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.
+
+### Legal stuff
+
+I can’t guarantee that my work will be error-free and so I can’t be liable to you or any third-party for damages, including lost profits, lost savings or other incidental, consequential or special damages, even if you’ve advised me of them. Finally, if any provision of this contract shall be unlawful, void, or for any reason unenforceable, then that provision shall be deemed severable from this contract and shall not affect the validity and enforceability of any remaining provisions.
+
+### 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.
+
+Then, when your final payment has cleared, copyright will be automatically assigned as follows:
+
+You’ll own the visual elements that I create for this project. I'll give you source files and finished files and you should keep them somewhere safe as I’re not required to keep a copy. You own all elements of text, images and data you provided, unless someone else owns them.
+
+I'll own the unique combination of these elements that constitutes a complete design and I'll license its use to you, exclusively and in perpetuity for this project only, unless I agree otherwise.
+
+### Displaying my work
+
+I love to show off my work, so I reserve the right to display all aspects of my creative work, including sketches, work-in-progress designs and the completed project on my portfolio and in articles on websites, in magazine articles and in books.
+
+### Payment schedule
+
+I’m sure you understand how important it is as a small business that you pay the invoices that I send you promptly. As I’m also sure you’ll want to stay friends, you agree to stick tight to the following payment schedule.
+
+[payment_details]
+[payment_schedule]
+
+
+I issue invoices electronically. my payment terms are [grace_period] days from the date of invoice by Interact eTransfer. All proposals are quoted in [currency] and payments will be made at the equivalent conversion rate at the date the transfer is made.
+
+You agree to pay all charges associated with international transfers of funds. The appropriate transfer details will be printed on my electronic invoice. I reserve the right to charge interest on all overdue debts at the rate of [interest_percentage]  per month or part of a month.
+
+### But where’s all the horrible small print?
+
+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.
+
+### The dotted line
+
+Signed by and on behalf of [company] _____________________
+Signed by and on behalf of [client]_____________________
+Date [date]

data/lib/contracter/version.rb

@@ -0,0 +1,3 @@
+class Contracter
+  VERSION = "0.1.0"
+end

data/lib/contracter.rb

@@ -0,0 +1,19 @@
+require "contracter/contract"
+
+class Contracter
+    def self.build &block
+        c = Contract.new
+        c.instance_eval(&block)
+
+        t = (c.instance_variable_get("@template_path") or File.expand_path("lib/contracter/template.md"))
+        self.fill_template(File.read(t), 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")
+    end
+end

metadata

@@ -0,0 +1,98 @@
+--- !ruby/object:Gem::Specification
+name: contracter
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Remi Gelinas
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2015-12-08 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.10'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.10'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: A Ruby gem that provides a simple DSL for generating web development
+  contracts.
+email:
+- remigelinas1@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- Gemfile
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- contracter.gemspec
+- lib/contracter.rb
+- lib/contracter/contract.rb
+- lib/contracter/template.md
+- lib/contracter/version.rb
+homepage: https://github.com/remi-gelinas/contracter
+licenses: []
+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.5.0
+signing_key: 
+specification_version: 4
+summary: A web development contract generator.
+test_files: []