rendaku 1.0.0 → 1.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: e331152fd22cbf0bfdc63cf645c14de30e021941
-  data.tar.gz: a8ef2e1b61a5f476b86024edb6513647680a94d5
+  metadata.gz: 14aecdb69c1ecc2eade7a6db74083f5effdaa35b
+  data.tar.gz: 581bf0344d0c774da2a2ad7674b539a8ad547829
 SHA512:
-  metadata.gz: e01b15e3361576f1942370f685f1d22d5ebfe80edf96219172d2875f39302cfb6ed52ca477e2141dcedc6e21d857d9dd700f42e08bcc7bcd31ea673a514e6e49
-  data.tar.gz: 715eb7e49535a00fd88610e17b39964cd8adba6f76df51be3ff8e97be3014924d1edd5f4434c56c461e905b35f1a729212590327b29c3a8b28d710d0bfae1dd0
+  metadata.gz: 77a3273edec8bb2d8cb1ed6786f14c653c04f9f73b1beb58d2ec9a865167cbb3ea400517e3803e39e81ee69ceaf5d34d0484a9a57b8f9db23b2c01c36feea414
+  data.tar.gz: cdd37879ef5effd767002aaaf7e5995fee3ac17d868083da6c6b2d9670a4b78c42667578d91971e572d354373e7aeda9f5cf074127dd6a30c39a0d18619786da

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    rendaku (0.0.0)
+    rendaku (1.0.0)
       rmagick (~> 2.13)
 
 GEM

data/README.md

@@ -3,9 +3,49 @@
 Rendaku is a ruby gem which accepts book dimensions and a simple image file for
 generating book art page-folding instructions.
 
-![image](https://i.imgur.com/9KTDiUG.png)
+![book-folding art by my wife](https://i.imgur.com/9KTDiUG.png)
+
 
 Inspired by the work at https://github.com/Moini/BookArtGenerator
 
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'rendaku'
+```
+
+And then execute:
+
+```shell
+bundle
+```
+
+Or install it locally:
+
+```shell
+gem install rendaku
+```
+
+## Usage
+
+```ruby
+book_first_page   = 2
+book_last_page    = 300
+book_height_in_cm = 18 # or inches
+book = Rendaku::Book.new book_first_page, book_last_page, book_height_in_cm
+
+# image can be of jpeg, gif, or png format,
+# but should be a simple black & white image for best results
+image = Rendaku::Image::read('/path/to/file.png').first
+
+pattern = Rendaku::Pattern.new book, image
 
+pattern.book #=> #<Rendaku::Book:0x007fde931e03b0 @first_page=2, @last_page=300, @height=18>
+pattern.image #=> /path/to/file.png PNG 629x1241=>150x1800 150x1800+0+0 DirectClass 8-bit
 
+# the template outputs a list of page numbers and associated folds
+# measured from the bottom of the page
+pattern.template #=> [[{ :page => 2, :top => 6.04, :bottom => 6.08 }],[{ :page => 4, :top => 6.02, :bottom => 6.11 }]]
+```

data/lib/rendaku/version.rb

@@ -1,3 +1,3 @@
 module Rendaku
-  VERSION = "1.0.0"
+  VERSION = "1.0.1"
 end

data/lib/rendaku.rb

@@ -26,9 +26,9 @@ module Rendaku
       def fold_template pattern
         template = []
         pattern.each_with_index do |contents, col|
-          top_corner = contents[0][:start]
+          top_corner    = contents[0][:start]
           bottom_corner = contents[0][:end]
-          page = (col*2) + @book.first_page
+          page          = (col*2) + @book.first_page
 
           template << { page: page, top: top_corner, bottom: bottom_corner }
         end

data/rendaku.gemspec

@@ -16,5 +16,6 @@ Gem::Specification.new do |s|
   s.test_files    = s.files.grep(%r{^(test|spec|features)/})
   s.require_paths = ['lib']
 
+  s.required_ruby_version = ">= 1.9.3"
   s.add_dependency 'rmagick', '~> 2.13'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rendaku
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.0.1
 platform: ruby
 authors:
 - Travis Anderson
@@ -52,7 +52,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 1.9.3
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="