draught 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: f97b0d14ba36e7199c9f941d1ce79e0e47b94b88
+  data.tar.gz: cfcb571fea88b2057ce38a2980bcd7a1fd542071
+SHA512:
+  metadata.gz: '05487261c930a1b093c7b2fd0c524c0cb05ab1a7724d43bb7fa0d2f4bb614c6c7d28fdbbafa12ed1bdd732df5e7f841e624f07065307cb96b4b23001dd06a540'
+  data.tar.gz: 753a9862b9593e3bda6e9449f4a9b253c53d605d73763eecfc6d70f69ccaefc79fd205c909e599c2a2884597215616c9b3318fda3045979d06de65bdadcc8c47

data/.gitignore

@@ -0,0 +1,15 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+*.pdf
+
+# rspec failure tracking
+.rspec_status
+# simplecov reports
+coverage

data/.rspec

@@ -0,0 +1,4 @@
+--format documentation
+--color
+--require spec_helper
+--order rand

data/.ruby-version

@@ -0,0 +1 @@
+2.4

data/.travis.yml

@@ -0,0 +1,19 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.4.0
+env:
+  global:
+    - GIT_COMMITTED_AT=$(if [ "$TRAVIS_PULL_REQUEST" == "false" ]; then git log -1 --pretty=format:%ct; else git log -1 --skip 1 --pretty=format:%ct; fi)
+before_script:
+  - curl -L https://codeclimate.com/downloads/test-reporter/test-reporter-latest-linux-amd64 > ./cc-test-reporter
+  - chmod +x ./cc-test-reporter
+script:
+  - bundle exec rake
+  # Preferably you will run test-reporter on branch update events. But
+  # if you setup travis to build PR updates only, you don't need to run
+  # the line below
+  - if [ "$TRAVIS_PULL_REQUEST" == "false" ]; then ./cc-test-reporter after-build --exit-code $TRAVIS_TEST_RESULT; fi
+  # In the case where travis is setup to build PR updates only,
+  # uncomment the line below
+  # - ./cc-test-reporter after-build --exit-code $TRAVIS_TEST_RESULT

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at matt@reprocessed.org. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [http://contributor-covenant.org/version/1/4][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/4/

data/Gemfile

@@ -0,0 +1,3 @@
+source 'https://rubygems.org'
+
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2017 Matt Patterson
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,62 @@
+# Draught - a Geometry library for creating vector graphics
+
+> draught, v.
+>
+> 2. To make a plan or sketch of; esp. to draw a preliminary plan of (something to be constructed); to design. (Sometimes draft.)
+>
+> [Oxford English Dictionary](http://www.oed.com/view/Entry/57521?result=2&rskey=9oHsDI)
+
+Draught is a library for creating vector graphics as PDFs. It's grown out of generating shapes that can be laser cut, and that's still its focus.
+
+TODO: Explain the fundamental concepts
+
+## Installation
+
+To use it as a library add this line to your application's Gemfile:
+
+```ruby
+gem 'draught'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install draught
+
+## Usage
+
+Example docs are bad and I will fix them.
+
+Also having to require everything individually.
+
+Create a simple straight line and add it to a sheet, then generate a PDF with it:
+
+```ruby
+require 'draught/line'
+require 'draught/bounding_box'
+require 'draught/sheet'
+require 'draught/renderer'
+
+line = Draught::Line.horizontal(100).translate(Draught::Vector.new(100,100))
+box = Draught::BoundingBox.new(line)
+sheet = Draught::Sheet.new(width: 300, height: 200, containers: [box])
+
+renderer = Draught::Renderer.render_to_file(sheet, './example.pdf')
+```
+
+## 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/fidothe/draught. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).

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 "draught"
+
+# 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(__FILE__)

data/bin/setup

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

data/draught.gemspec

@@ -0,0 +1,28 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'draught/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "draught"
+  spec.version       = Draught::VERSION
+  spec.authors       = ["Matt Patterson"]
+  spec.email         = ["matt@reprocessed.org"]
+
+  spec.summary       = %q{A library for creating 2D vector graphics as PDF.}
+  spec.homepage      = "https://github.com/fidothe/draught"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "prawn", "~> 2.1"
+  spec.add_development_dependency "bundler", "~> 1.14"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+  spec.add_development_dependency 'simplecov'
+end

data/lib/draught.rb

@@ -0,0 +1,4 @@
+require "draught/version"
+
+module Draught
+end

data/lib/draught/arc_builder.rb

@@ -0,0 +1,161 @@
+require_relative './point'
+require_relative './vector'
+require_relative './cubic_bezier'
+require_relative './curve'
+require_relative './path'
+require_relative './transformations'
+
+module Draught
+  class ArcBuilder
+    # Largest arc segment representable by a single Cubic Bézier is 90º
+    # There's enough jitter in floating point maths that we round the result
+    # to 12 d.p. which means we avoid requiring two segments to represent an
+    # arc of 90.000000000000000001º
+    LARGEST_SEGMENT_RADIANS = (Math::PI / 2.0).round(12)
+    CIRCLE_RADIANS = Math::PI * 2
+
+    attr_reader :radius, :starting_angle, :radians
+
+    def self.deg_to_rad(degrees)
+      degrees * (Math::PI / 180)
+    end
+
+    def self.radians(args = {})
+      new_args = args.merge(radians: args[:angle])
+      new(new_args)
+    end
+
+    def self.degrees(args = {})
+      new_args = {radius: args[:radius]}
+      new_args[:radians] = deg_to_rad(args.fetch(:angle))
+      new_args[:starting_angle] = deg_to_rad(args.fetch(:starting_angle, 0))
+      new(new_args)
+    end
+
+    def initialize(args = {})
+      @radius = args.fetch(:radius)
+      @starting_angle = args.fetch(:starting_angle, 0)
+      @radians = args.fetch(:radians)
+    end
+
+    def path
+      @path ||= Path.new([start_point, curve])
+    end
+
+    def start_point
+      @start_point ||= untranslated_start_point.transform(transformer)
+    end
+
+    def curve
+      @curve ||= Curve.new({
+        point: segments.last.end_point,
+        cubic_beziers: segments.map { |s| s.cubic_bezier }
+      }).transform(transformer)
+    end
+
+    private
+
+    def untranslated_start_point
+      segments.first.first_point
+    end
+
+    def segments
+      @segments ||= begin
+        remaining_angle = positive_radians
+        start = starting_angle
+        segments = []
+        while remaining_angle > LARGEST_SEGMENT_RADIANS
+          remaining_angle = remaining_angle - LARGEST_SEGMENT_RADIANS
+          segments << SegmentBuilder.new(LARGEST_SEGMENT_RADIANS, start, radius)
+          start = positive_radians + starting_angle - remaining_angle
+        end
+        segments << SegmentBuilder.new(remaining_angle, start, radius)
+      end
+    end
+
+    def positive_radians
+      radians.abs
+    end
+
+    def transformer
+      @transformer ||= begin
+        transformations = [translation_transformer]
+        transformations << Transformations.x_axis_reflect if negative?
+        Transformations::Composer.compose(*transformations)
+      end
+    end
+
+    def translation_transformer
+      @translation_transformer ||= Vector.translation_to_zero(untranslated_start_point).to_transform
+    end
+
+    def negative?
+      !positive?
+    end
+
+    def positive?
+      radians >= 0
+    end
+
+    # @api: private
+    # Based on learnings from http://www.tinaja.com/glib/bezcirc2.pdf,
+    # via http://www.whizkidtech.redprince.net/bezier/circle/
+    class SegmentBuilder
+      attr_reader :sweep, :start, :radius
+
+      def initialize(sweep, start, radius)
+        @sweep, @start, @radius = sweep, start, radius
+      end
+
+      def first_point
+        @first_point ||= Point.new(x0, -y0).transform(transform)
+      end
+
+      def end_point
+        @end_point ||= Point.new(x0, y0).transform(transform)
+      end
+
+      def cubic_bezier
+        @cubic_bezier ||= CubicBezier.new({
+          end_point: end_point, control_point_1: control_point_1, control_point_2: control_point_2
+        })
+      end
+
+      private
+
+      def control_point_1
+        Point.new(x1, -y1).transform(transform)
+      end
+
+      def control_point_2
+        Point.new(x1, y1).transform(transform)
+      end
+
+      def transform
+        @transform ||= Transformations::Composer.compose(
+          Transformations.rotate(start + sweep_offset), Transformations.scale(radius)
+        )
+      end
+
+      def sweep_offset
+        @sweep_offset ||= sweep / 2.0
+      end
+
+      def x0
+        Math.cos(sweep_offset)
+      end
+
+      def y0
+        Math.sin(sweep_offset)
+      end
+
+      def x1
+        (4 - x0)/3.0
+      end
+
+      def y1
+        ((1 - x0) * (3 - x0)) / (3 * y0)
+      end
+    end
+  end
+end