dot_grid 0.0.5 → 0.0.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 7ffb5b75ffa638ae3bfd9d7b42ca6ef7c6bc92a9
-  data.tar.gz: e5849864c9d5bb7671909055a2b352d63bfb915d
+  metadata.gz: c613a6399306399f56670ee1d5c71eb19f0482fa
+  data.tar.gz: 1e84551b573e9a4da0ce43ef124e934da2361e1b
 SHA512:
-  metadata.gz: c362a59e770ac32c855d1c3ba63937c42dcab3bdb132705fa134ccb813cdf760d1fb8b0ccb681f6ea85db6f134867dada43c5ff96ff4d12b71d7aaaeb9d06222
-  data.tar.gz: 2a8006d84e41212fc53045952e0ffb4da63850a576c3664f7448e478a9c4c3a5f3181fb27c26c6ee754f6709c47ab2c256986faba95cb0bef471d1b4ceb5066d
+  metadata.gz: 2537b83875baf3ac3a25bbaee024eddd5152a51f02fd3b1194bad971739cafe74b09652533a5477d3683e71e9df4153f3f6cc64e2a414911b38fd604ad62a9ea
+  data.tar.gz: 51f22e55418a3b4c594da771c0fa4906cff45adb163308351e21571555e5239e114f2fcc0cc8be1188160caadda44ddaae3b4a48c7366ed3d701d852daca0e31

data/Gemfile.lock

@@ -1,8 +1,8 @@
 PATH
   remote: .
   specs:
-    dot_grid (0.0.5)
-      prawn (~> 1.0.0)
+    dot_grid (0.0.6)
+      prawn (~> 1.1.0)
       require_all (~> 1.3.2)
       trollop (~> 2.0)
 
@@ -20,9 +20,9 @@ GEM
     mime-types (2.3)
     multi_json (1.10.1)
     pdf-core (0.2.5)
-    prawn (1.0.0)
-      pdf-core (~> 0.2.2)
-      ttfunk (~> 1.1.1)
+    prawn (1.1.0)
+      pdf-core (~> 0.2.5)
+      ttfunk (~> 1.2.0)
     rake (10.3.2)
     require_all (1.3.2)
     rest-client (1.6.7)
@@ -45,7 +45,7 @@ GEM
     thor (0.19.1)
     tins (1.3.0)
     trollop (2.0)
-    ttfunk (1.1.1)
+    ttfunk (1.2.0)
 
 PLATFORMS
   ruby

data/README.md

@@ -1,6 +1,7 @@
 [![Build Status](https://travis-ci.org/slabounty/dot_grid.svg?branch=master)](https://travis-ci.org/slabounty/dot_grid)
 [![Coverage Status](https://coveralls.io/repos/slabounty/dot_grid/badge.png?branch=master)](https://coveralls.io/r/slabounty/dot_grid?branch=master)
 [![Code Climate](https://codeclimate.com/github/slabounty/dot_grid.png)](https://codeclimate.com/github/slabounty/dot_grid)
+[![Dependency Status](https://gemnasium.com/slabounty/dot_grid.svg)](https://gemnasium.com/slabounty/dot_grid)
 
 # DotGrid: dot grid planning pages
 
@@ -14,11 +15,11 @@ A simple ruby file for generating dot grid graph paper.
 
 A basic dot grid page can be generated like this ...
 
-    bin/dotgrid -f dotgrid.pdf --grid-color CFBAEC --dot-weight 0.5 -m 0.0
+    bin/dotgrid -f dot_grid.pdf --page-types dot-grid --spacing 5 --grid-color CFBAEC --dot-weight 0.5 -m 0.0
 
 A basic planning page can be generated like this ...
 
-    bin/dotgrid -f dotgrid_w5_c2dfff_no_grid.pdf --no-grid --grid-color CFBAEC --dot-weight 0.5 -m 0.0 --planner --planner-color-1 dddddd --planner-color-2 C2DFFF
+  bin/dotgrid -f planner_w5_c2dfff.pdf  --page-types planner --grid-color CFBAEC --dot-weight 0.5 -m 0.0 --planner-color-1 dddddd --planner-color-2 C2DFFF
 
 To get help on the command and its options ...
     bin/dotgrid --help
@@ -34,17 +35,13 @@ The options and their defaults are ...
 </thead>
 <tbody>
 <tr><td>file-name</td><td>-f</td><td>dotgrid.pdf</td></tr>
-<tr><td>grid</td><td>-g</td><td>true</td></tr>
+<tr><td>page-types</td><td>-p</td><td>Types of pages desired: DotGrid, Planner, Grid, HorizontalRule, Checkerboard (default: Planner)</td></tr>
 <tr><td>dot-weight</td><td>-d</td><td>1.5</td></tr>
 <tr><td>margin</td><td>-m</td><td>0.5</td></tr>
-<tr><td>page-size</td><td>-p</td><td>LETTER</td></tr>
-<tr><td>grid-color</td><td>-r</td><td>B3B3B3</td></tr>
+<tr><td>page-size</td><td>-a</td><td>LETTER</td></tr>
+<tr><td>grid-color</td><td>-g</td><td>B3B3B3</td></tr>
 <tr><td>spacing</td><td>-s</td><td>5</td></tr>
-<tr><td>pages</td><td>-a</td><td>1</td></tr>
-<tr><td>planner</td><td>-l</td><td>false</td></tr>
-<tr><td>planner-color-1</td><td>-n</td><td>CCCCCC</td></tr>
-<tr><td>planner-color-2</td><td>-e</td><td>0099FF</td></tr>
+<tr><td>planner-color-1</td><td>-l</td><td>CCCCCC</td></tr>
+<tr><td>planner-color-2</td><td>-n</td><td>0099FF</td></tr>
 </tbody>
 </table>
-
-## Examples

data/base

@@ -1,15 +1,21 @@
 # Base planner
-bin/dotgrid -f planner_w5_c2dfff_no_grid.pdf --no-dot-grid --grid-color CFBAEC --dot-weight 0.5 -m 0.0 --planner --planner-color-1 dddddd --planner-color-2 C2DFFF
-bin/dotgrid -f planner_w75_c2dfff_no_grid.pdf --no-dot-grid --grid-color CFBAEC --dot-weight 0.75 -m 0.0 --planner --planner-color-1 dddddd --planner-color-2 C2DFFF
+bin/dotgrid -f planner_w5_c2dfff.pdf  --page-types planner --grid-color CFBAEC --dot-weight 0.5 --margin 0.0 --planner-color-1 dddddd --planner-color-2 C2DFFF
+bin/dotgrid -f planner_w75_c2dfff.pdf --page-types planner --grid-color CFBAEC --dot-weight 0.75 --margin 0.0 --planner-color-1 dddddd --planner-color-2 C2DFFF
 
 # Dot grid
-bin/dotgrid -f dot_grid_c2dfff.pdf --dot-grid --spacing 5 --grid-color CFBAEC -m 0.0
+bin/dotgrid -f dot_grid_c2dfff.pdf --page-types dot_grid --spacing 5 --grid-color CFBAEC --margin 0.0
 
 # Regular grid
-bin/dotgrid -f grid_c2dfff.pdf --grid --no-dot-grid --spacing 5 --grid-color CFBAEC -m 0.0
+bin/dotgrid -f grid_c2dfff.pdf --page-types grid  --spacing 5 --grid-color CFBAEC --margin 0.0
 
 # Horizontal rule
-bin/dotgrid -f horizontal_rule_c2dfff.pdf --horizontal-rule --no-dot-grid --spacing 5 --grid-color CFBAEC -m 0.0
+bin/dotgrid -f horizontal_rule_c2dfff.pdf --page-types horizontal-rule  --spacing 5 --grid-color CFBAEC --margin 0.0
 
 # Checkerboard
-bin/dotgrid -f checkerboard_c2dfff.pdf --checkerboard --no-dot-grid --spacing 5 --grid-color CFBAEC -m 0.0
+bin/dotgrid -f checkerboard_c2dfff.pdf --page-types checkerboard  --spacing 5 --grid-color CFBAEC --margin 0.0
+
+# Page Types (either with no spaces after commas or in quotes).
+bin/dotgrid -f page_types.pdf --page-types "planner, checkerboard, grid, dot_grid"  --spacing 5 --grid-color CFBAEC --margin 0.0
+
+# Everything all at once ...
+ bin/dotgrid -f page_types.pdf --page-types "planner, checkerboard, grid, dot_grid, horizontal_rule" --spacing 5 --grid-color CFBAEC -m 0.0

data/bin/dotgrid

@@ -10,17 +10,12 @@ require_all 'lib'
 
 opts = Trollop::options do
   opt :file_name, "File Name", :type => :string, :default => "dotgrid.pdf"
-  opt :dot_grid, "Add a Dot Grid Page", default: true
+  opt :page_types, "Types of pages desired: Types of pages desired: DotGrid, Planner, Grid, HorizontalRule, Checkerboard", type: :string, default: "Planner"
   opt :dot_weight, "Dot Weight", :type => :float, :default => 1.5
   opt :margin, "Border", :type => :float, :default => 0.5
   opt :page_size, "Page Size (LEGAL, LETTER)", :type => :string, :default => "LETTER"
   opt :grid_color, "Grid Color (RGB)", :type => :string, :default => "B3B3B3"
   opt :spacing, "Dot Spacing (mm)", :type => :integer, :default => 5
-  opt :pages, "Number of pages", :type => :integer, :default => 1
-  opt :planner, "Add a Planner Page"
-  opt :grid, "Add a Regular Grid page"
-  opt :horizontal_rule, "Add a Horizontal Rule page"
-  opt :checkerboard, "Add a Checkerboard page"
   opt :planner_color_1, "Planner Left and Footer color", type: :string, default: "CCCCCC"
   opt :planner_color_2, "Planner Right color", type: :string, default: "0099ff"
 end

data/dot_grid.gemspec

@@ -19,7 +19,7 @@ Gem::Specification.new do |gem|
   gem.add_development_dependency "rspec", '~> 2.14.1'
   gem.add_development_dependency "rake", '~> 10.3.2'
   gem.add_development_dependency "coveralls"
-  gem.add_dependency "prawn", '~> 1.0.0'
+  gem.add_dependency "prawn", '~> 1.1.0'
   gem.add_dependency "trollop", '~> 2.0'
   gem.add_dependency "require_all", '~> 1.3.2'
 end

data/lib/dot_grid/generator.rb

@@ -7,42 +7,29 @@ module DotGrid
       :pdf,
       :file_name,
       :page_size,
-      :grid,
-      :dot_grid_page,
-      :grid_page,
       :margin,
       :pages,
-      :planner,
-      :planner_page,
-      :horizontal_rule,
-      :horizontal_rule_page,
-      :checkerboard,
-      :checkerboard_page,
+      :page_types
     )
 
     def initialize(params)
       @file_name = params[:file_name] || "dotgrid.pdf"
       @page_size = params[:page_size] || "LETTER"
       @margin = params[:margin] || 0.5
-      @pages = params[:pages] || 1
+      @page_types = params[:page_types] ? params[:page_types].split(",") : ["planner"]
       @pdf = Prawn::Document.new(margin: margin, page_size: page_size, skip_page_creation: true)
       params[:pdf] = pdf
+      @pages = create_pages(params)
+    end
 
-      @dot_grid_page = DotGrid::Page::DotGrid.new(params) if params[:dot_grid]
-      @planner_page = DotGrid::Page::Planner.new(params) if params[:planner]
-      @grid_page = DotGrid::Page::Grid.new(params) if params[:grid]
-      @horizontal_rule_page = DotGrid::Page::HorizontalRule.new(params) if params[:horizontal_rule]
-      @checkerboard_page = DotGrid::Page::Checkerboard.new(params) if params[:checkerboard]
+    def create_pages(params)
+      page_types.map do |p|
+        DotGrid::Page::Factory.build(p.strip, params.clone)
+      end
     end
 
     def generate
-      (1..pages).each do |page|
-        planner_page.generate if planner_page
-        grid_page.generate if grid_page
-        dot_grid_page.generate if dot_grid_page
-        horizontal_rule_page.generate if horizontal_rule_page
-        checkerboard_page.generate if checkerboard_page
-      end
+      pages.each { |page| page.generate }
       pdf.render_file file_name
     end
   end

data/lib/dot_grid/page/factory.rb

@@ -0,0 +1,20 @@
+module DotGrid
+  module Page
+    class Factory
+      class UnknownPageExeception < Exception; end
+
+      PAGES = {
+        'dot_grid'        => ::DotGrid::Page::DotGrid,
+        'planner'         => ::DotGrid::Page::Planner,
+        'grid'            => ::DotGrid::Page::Grid,
+        'horizontal_rule' => ::DotGrid::Page::HorizontalRule,
+        'checkerboard'    => ::DotGrid::Page::Checkerboard
+      }
+
+      def self.build(page_type, params)
+        raise UnknownPageExeception, "Unknown page type: #{page_type}" unless PAGES[page_type]
+        PAGES[page_type].new(params)
+      end
+    end
+  end
+end

data/lib/dot_grid/version.rb

@@ -1,3 +1,3 @@
 module DotGrid
-  VERSION = "0.0.5"
+  VERSION = "0.0.6"
 end

data/lib/dot_grid.rb

@@ -7,6 +7,7 @@ require 'dot_grid/page/planner'
 require 'dot_grid/page/grid'
 require 'dot_grid/page/horizontal_rule'
 require 'dot_grid/page/checkerboard'
+require 'dot_grid/page/factory'
 
 require 'dot_grid/pattern/pattern'
 require 'dot_grid/pattern/grid'

data/spec/lib/dot_grid/generator_spec.rb

@@ -16,77 +16,16 @@ describe "DotGrid::Generator" do
       expect(subject.margin).to eq(0.5)
     end
 
-    it "has a default number of pages" do
-      expect(subject.pages).to eq(1)
-    end
-
     it "creates a pdf file" do
-      expect(Prawn::Document).to receive(:new)
-      subject
-    end
-
-    context "when there is a grid parameter" do
-      it "creates a new grid page" do
-        expect(DotGrid::Page::DotGrid).to receive(:new)
-        DotGrid::Generator.new({:dot_grid => true})
-      end
+      expect(subject.pdf).to be_a(Prawn::Document)
     end
 
-    context "when there is a planner parameter" do
-      it "creates a new grid page" do
-        expect(DotGrid::Page::Planner).to receive(:new)
-        DotGrid::Generator.new({:planner => true})
-      end
+    it "creates the pages" do
+      expect(subject.page_types).to have(1).page
     end
   end
 
   describe "#generate" do
-    context "when there is a planner page" do
-      let(:subject) { DotGrid::Generator.new(:planner => true)}
-      it "generates a new planner page" do
-        expect(subject.planner_page).to receive(:generate)
-        subject.generate
-      end
-    end
-
-    context "when there is a dot grid page" do
-      let(:subject) { DotGrid::Generator.new(:dot_grid => true)}
-      it "generates a new grid page" do
-        expect(subject.dot_grid_page).to receive(:generate)
-        subject.generate
-      end
-    end
-
-    context "when there is a grid page" do
-      let(:subject) { DotGrid::Generator.new(:grid => true)}
-      it "generates a new grid page" do
-        expect(subject.grid_page).to receive(:generate)
-        subject.generate
-      end
-    end
-
-    context "when there is a horizontal rule page" do
-      let(:subject) { DotGrid::Generator.new(:horizontal_rule => true)}
-      it "generates a new horizontal rule page" do
-        expect(subject.horizontal_rule_page).to receive(:generate)
-        subject.generate
-      end
-    end
-
-    context "when there are multiple pages" do
-      let(:subject) { DotGrid::Generator.new(:dot_grid => true, :planner => true, :pages => 2)}
-
-      it "generates grid for each page" do
-        expect(subject.dot_grid_page).to receive(:generate).twice
-        subject.generate
-      end
-
-      it "generates a planner for each page" do
-        expect(subject.planner_page).to receive(:generate).twice
-        subject.generate
-      end
-    end
-
     it "renders a file with the file name" do
       subject = DotGrid::Generator.new({})
       expect(subject.pdf).to receive(:render_file).with(subject.file_name)

data/spec/lib/dot_grid/page/factory_spec.rb

@@ -0,0 +1,18 @@
+require 'spec_helper'
+
+describe "DotGrid::Page::Factory" do
+  describe ".build" do
+    context "when the page is unknown" do
+      it "raises an exception" do
+        expect {DotGrid::Page::Factory.build('xyz', {})}.to raise_error( DotGrid::Page::Factory::UnknownPageExeception)
+      end
+    end
+
+    context "when the page is known" do
+      it "builds the page" do
+        expect(::DotGrid::Page::Planner).to receive(:new)
+        DotGrid::Page::Factory.build('planner', {})
+      end
+    end
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: dot_grid
 version: !ruby/object:Gem::Version
-  version: 0.0.5
+  version: 0.0.6
 platform: ruby
 authors:
 - Scott LaBounty
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-07-14 00:00:00.000000000 Z
+date: 2014-07-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec
@@ -58,14 +58,14 @@ dependencies:
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: 1.0.0
+        version: 1.1.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: 1.0.0
+        version: 1.1.0
 - !ruby/object:Gem::Dependency
   name: trollop
   requirement: !ruby/object:Gem::Requirement
@@ -119,6 +119,7 @@ files:
 - lib/dot_grid/generator.rb
 - lib/dot_grid/page/checkerboard.rb
 - lib/dot_grid/page/dot_grid.rb
+- lib/dot_grid/page/factory.rb
 - lib/dot_grid/page/grid.rb
 - lib/dot_grid/page/horizontal_rule.rb
 - lib/dot_grid/page/page.rb
@@ -133,6 +134,7 @@ files:
 - spec/lib/dot_grid/generator_spec.rb
 - spec/lib/dot_grid/page/checkerboard_spec.rb
 - spec/lib/dot_grid/page/dot_grid_spec.rb
+- spec/lib/dot_grid/page/factory_spec.rb
 - spec/lib/dot_grid/page/grid_spec.rb
 - spec/lib/dot_grid/page/horizontal_rule_spec.rb
 - spec/lib/dot_grid/page/page_spec.rb
@@ -171,6 +173,7 @@ test_files:
 - spec/lib/dot_grid/generator_spec.rb
 - spec/lib/dot_grid/page/checkerboard_spec.rb
 - spec/lib/dot_grid/page/dot_grid_spec.rb
+- spec/lib/dot_grid/page/factory_spec.rb
 - spec/lib/dot_grid/page/grid_spec.rb
 - spec/lib/dot_grid/page/horizontal_rule_spec.rb
 - spec/lib/dot_grid/page/page_spec.rb