bread-basket 0.0.0 → 0.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 8e88de24214b514b997f49898747732ceacc0a73
-  data.tar.gz: 50c00bbc435f9797d45079dfb4740c1588f421d4
+  metadata.gz: 9cd2a8c7a51afc5eccbd1e627a982d10e59c1501
+  data.tar.gz: 4352f64d75add2341aafd3c9bc06f45bd475b4bf
 SHA512:
-  metadata.gz: 444d8e8ec75f35a219cb09fe80da4b4abc8938ab358f7ace7e12b89d4b20388bd6ec6ab0d1b4fed20916eae3f1f019779c3f08766c19dbde0d57bf0e22cafccd
-  data.tar.gz: 911ccad5a2c93f460a7ef50d0274a03afbbf7563cf25963838776edebae631ee5d3d9c656fb376991ce2565518e11ecc08982f9e2b3490a98d322117604e67e2
+  metadata.gz: d8c4cc7727a2a881a5e5a13b3be478a8d8628b2d065c6fd85367f23a684831e6decedd401422760d6d592a8eb94e5649e1b5fe33a62aab95d1e821f7814510b6
+  data.tar.gz: 92024548da731c38005e6d9ec119e30604b3a369756e4c347c61c9ed9d75e49931894f6c87ab470c119a928bab4f1ba653f6bfb7959c28bf06e4ab59f1cce361

data/.rspec

@@ -0,0 +1,4 @@
+--color
+--format progress
+--order random
+--require spec_helper

data/.rubocop.yml

@@ -0,0 +1,18 @@
+# This cop checks for top-level documentation of classes and modules.
+Style/Documentation:
+  Enabled: false
+
+# This cop checks for snake_case ruby file names.
+# It is off because it triggers on ruby shebang.
+Style/FileName:
+  Enabled: false
+
+# This cop wisely checks for eval, but I use it carefully so
+# it'll have to be silent
+Lint/Eval:
+  Enabled: false
+
+# My namespace puts methods 5 indents in 80->90
+# many methods add at least 1 more indent 90->92
+Metrics/LineLength:
+  Max: 92

data/.travis.yml

@@ -2,9 +2,12 @@ language: ruby
 cache: bundler
 
 rvm:
-  - jruby
   - 2.0.0
 
+# Not sure why I need this!
+before_install:
+  - 'gem install bundler'
+
 script: 'bundle exec rake'
 
 notifications:

data/Gemfile

@@ -1,4 +1,4 @@
 source 'https://rubygems.org'
 
-# Specify your gem's dependencies in bread-basket.gemspec
+# Gem's dependencies are specified in bread-basket.gemspec
 gemspec

data/Guardfile

@@ -1,11 +1,16 @@
 guard :rspec, cmd: 'bundle exec rspec' do
   # watch /lib/ files
-  watch(%r{^lib/(.+).rb$}) do |m|
+  watch(/^lib\/(.+).rb$/) do |m|
     "spec/#{m[1]}_spec.rb"
   end
 
   # watch /spec/ files
-  watch(%r{^spec/(.+).rb$}) do |m|
+  watch(/^spec\/(.+).rb$/) do |m|
     "spec/#{m[1]}.rb"
   end
 end
+
+guard :rubocop do
+  watch(/.+\.rb$/)
+  watch(/(?:.+\/)?\.rubocop\.yml$/) { |m| File.dirname(m[0]) }
+end

data/README.md

@@ -1,36 +1,47 @@
 # Basket
+[![Build Status](https://travis-ci.org/bread/bread-basket.svg?branch=master)](https://travis-ci.org/bread/bread-basket)
+[![Coverage Status](https://coveralls.io/repos/bread/bread-basket/badge.svg?branch=master)](https://coveralls.io/r/bread/bread-basket?branch=master)
 
-Basket is a tool for publishing scientific findings. It's the last piece of the :bread: framework for scientific computing.
+Basket is a tool for publishing scientific findings.
+It's the last piece of the :bread: framework for scientific computing.
+But it's the first thing I've tried to build in that framework.
 
-For now it just makes scientific posters. In the future thought it should help make figures, presentations, and maybe even full journal articles.
+When the `Poster` module is finished it will make scientific posters.
+In the future however, `bread-basket` should help make
+figures, presentations, and maybe even full journal articles.
 
-## Installation
+## Installation and Usage
 
-Add this line to your application's Gemfile:
+Since :bread: hasn't been built (at all) yet, this little piece of the framework
+is pretty lonely. So for now it's just a command-line utility
+for making scientific posters. To use it, first get it into your Ruby environment with
 
-```ruby
-gem 'bread-basket'
-```
-
-And then execute:
+    $ gem install bread-basket
 
-    $ bundle
+(If you're brand new to Ruby and not so sure about the above line, I plan to put
+an introduction to Ruby for scientists on the bread homepage. So just sit tight
+until I get that built.)
 
-Or install it yourself as:
+Once that's installed you should be able to convert a suitable markdown file
+(with your poster's content) and stylesheet into a nice pdf like so
 
-    $ gem install bread-basket
+    $ bread-basket poster my-poster.md
 
-## Usage
+and it will produce a pdf that you can take to the printers!
 
-The only tool in the Bread Basket is Posterize. You should call it from the command line with the path to your poster markdown file like so
+For more information on how to write the markdown file for your poster
+check out the example below, or email me. In the future a website will
+provide some good documentation.
 
-    $ posterize my-poster.md
+## Example
 
-and it will produce a pdf that you can take to the printers. For more information on how to write the markdown file for you poster check out the website (doesn't exist yet).
+The samples folder contains an example poster `lorem_flow.md` along with the pdf
+this software creates. Right now this is the only sample that works so go check it
+out.
 
 ## Contributing
 
-1. Fork it ( https://github.com/[my-github-username]/bread-basket/fork )
+1. Fork it ( https://github.com/bread/bread-basket/fork )
 2. Create your feature branch (`git checkout -b my-new-feature`)
 3. Commit your changes (`git commit -am 'Add some feature'`)
 4. Push to the branch (`git push origin my-new-feature`)

data/Rakefile

@@ -1,10 +1,17 @@
 require 'rspec/core/rake_task'
-require "bundler/gem_tasks"
+require 'bundler/gem_tasks'
+require 'rubocop/rake_task'
 
 # Default directory to look in is `/specs`
-# Run with `rake spec`
-RSpec::Core::RakeTask.new(:spec) do |task|
-  task.rspec_opts = ['--color', '--format', 'nested']
-end
+RSpec::Core::RakeTask.new(:spec)
+
+task default: :spec
 
-task :default => :spec
+desc 'Run RuboCop on the lib directory'
+RuboCop::RakeTask.new(:rubocop) do |task|
+  task.patterns = ['lib/bread/**/*.rb']
+  # only show the files with failures
+  task.formatters = ['files']
+  # don't abort rake on failure
+  task.fail_on_error = false
+end

data/bin/bread-basket

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+# Avoid running bundle exec by running this first instead!
+lib_directory = File.expand_path('../../lib', __FILE__)
+$LOAD_PATH << lib_directory
+
+if File.exist?('Gemfile')
+  require 'bundler/setup'
+  Bundler.require
+end
+
+require 'bread/basket'
+
+Bread::Basket::Cli.start(ARGV)

data/bread-basket.gemspec

@@ -4,32 +4,37 @@ $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 require 'bread/basket/version'
 
 Gem::Specification.new do |spec|
-  spec.name          = "bread-basket"
+  spec.name          = 'bread-basket'
   spec.version       = Bread::Basket::VERSION
-  spec.authors       = ["KC Erb"]
-  spec.email         = ["iamkcerb@gmail.com"]
-  spec.summary       = "The publication tool for bread"
-  spec.description   =
-    'Basket is a tool for publishing scientific findings. It\'s the last piece of ' +
-    'the :bread: framework for scientific computing.\n\nFor now it just makes' +
-    'scientific posters. In the future thought it should help make figures,' +
-    ' presentations, and maybe even full journal articles.'
-  spec.homepage      = "https://github.com/bread/bread-basket"
-  spec.license       = "MIT"
+  spec.authors       = ['KC Erb']
+  spec.email         = ['iamkcerb@gmail.com']
+  spec.summary       = 'The go-to publication tool for bread'
+  spec.description   = 'bread-basket is still under development. This release ' \
+                       'contains only bare-bones functionality'
+  spec.homepage      = 'https://github.com/bread/bread-basket'
+  spec.license       = 'MIT'
 
   spec.files         = `git ls-files -z`.split("\x0")
-  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
-  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
-  spec.require_paths = ["lib"]
+  spec.executables   = spec.files.grep(/^bin\//) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(/^(test|spec|features)\//)
+  spec.require_paths = ['lib']
 
-  spec.add_development_dependency "bundler", "~> 1.7"
-  spec.add_development_dependency "rake", "~> 10.0"
-  spec.add_development_dependency "rspec", "~> 3.2"
-  spec.add_development_dependency "rspec-nc", "~> 0"
-  spec.add_development_dependency "guard", "~> 2.12"
-  spec.add_development_dependency "guard-rspec", "~> 4.0"
-  spec.add_development_dependency "pry", "~> 0.10"
-  spec.add_development_dependency "pry-remote", "~> 0.1"
-  spec.add_development_dependency "pry-nav", "~> 0.2"
-  spec.add_development_dependency "coveralls", "~> 0.7"
+  spec.add_development_dependency 'bundler', '~> 1.9'
+  spec.add_development_dependency 'coveralls', '~> 0.7'
+  spec.add_development_dependency 'rake', '~> 10.4'
+  spec.add_development_dependency 'guard', '~> 2.12'
+  spec.add_development_dependency 'guard-rspec', '~> 4.5'
+  spec.add_development_dependency 'guard-rubocop', '~> 1.2'
+  spec.add_development_dependency 'pry', '~> 0.10'
+  spec.add_development_dependency 'pry-nav', '~> 0.2'
+  spec.add_development_dependency 'pry-remote', '~> 0.1'
+  spec.add_development_dependency 'rspec', '~> 3.2'
+  spec.add_development_dependency 'rspec-its', '~> 1.2'
+  spec.add_development_dependency 'rspec-nc', '~> 0'
+
+  spec.add_dependency 'css_parser', '~> 1.3'
+  spec.add_dependency 'fastimage', '~> 1.6'
+  spec.add_dependency 'prawn', '~> 2.0'
+  spec.add_dependency 'redcarpet', '~> 3.2'
+  spec.add_dependency 'thor', '~> 0.19'
 end

data/lib/bread/basket.rb

@@ -1,7 +1,13 @@
-require "bread/basket/version"
+# gems
+require 'yaml'
+require 'thor'
+require 'css_parser'
+require 'prawn'
+require 'prawn/measurement_extensions'
+require 'fastimage'
+require 'redcarpet'
 
-module Bread
-  module Basket
-    # Your code goes here...
-  end
-end
+# local
+require 'bread/basket/version'
+require 'bread/basket/cli'
+require 'bread/basket/poster'

data/lib/bread/basket/cli.rb

@@ -0,0 +1,10 @@
+module Bread
+  module Basket
+    class Cli < Thor
+      desc 'poster FILENAME', 'Creates a scientific poster from FILENAME'
+      def poster(file)
+        Bread::Basket::Poster::PosterMaker.new(file)
+      end
+    end
+  end
+end

data/lib/bread/basket/poster.rb

@@ -0,0 +1,38 @@
+require 'bread/basket/poster/prawn_patches/column_box'
+require 'bread/basket/poster/header_callback'
+require 'bread/basket/poster/header_maker'
+require 'bread/basket/poster/text_renderer'
+require 'bread/basket/poster/block_renderer'
+require 'bread/basket/poster/poster_maker'
+require 'bread/basket/poster/layout'
+require 'bread/basket/poster/box_checker'
+require 'bread/basket/poster/units_helper'
+require 'bread/basket/poster/dimensions_helper'
+require 'bread/basket/poster/box'
+require 'bread/basket/poster/image_box'
+require 'bread/basket/poster/columns'
+require 'bread/basket/poster/css_reader'
+require 'bread/basket/poster/pdf_builder'
+require 'bread/basket/poster/block_code_handler'
+
+module Bread
+  module Basket
+    module Poster
+      TEXT_RENDERER_OPTS = { fenced_code_blocks: true,
+                             disable_indented_code_blocks: true,
+                             underline: true,
+                             highlight: true,
+                             superscript: true,
+                             tables: true }
+      class << self
+        attr_accessor :dir_path, :layout, :pdf, :current_styles, :body
+      end
+
+      # Default dir path, since in some specs this doesn't get set
+      # this is a code smell and is on the to do list.
+      dirname = File.dirname(__FILE__)
+      Poster.dir_path = File.expand_path('../../../', dirname) + '/spec/poster/test_files'
+      Poster.current_styles = {}
+    end
+  end
+end

data/lib/bread/basket/poster/block_code_handler.rb

@@ -0,0 +1,50 @@
+module Bread
+  module Basket
+    module Poster
+      class BlockCodeHandler
+        attr_reader :pdf, :layout, :text_renderer
+
+        def initialize(pdf, layout, first_line, content)
+          @pdf = pdf
+          @layout = layout
+          @text_renderer = Redcarpet::Markdown.new(TextRenderer, TEXT_RENDERER_OPTS)
+          sort_input(first_line, content)
+        end
+
+        def sort_input(first_line, content)
+          case first_line
+          when /\A.*\.(jpg|jpeg|png)\Z/
+            create_image(first_line, content)
+          else
+            puts "Warning: Couldn't figure out what to do with #{content} block.\n"
+          end
+        end
+
+        # TODO: Get a lot of these values from the CSS
+        def create_image(image_src, caption)
+          image_path = Bread::Basket::Poster.dir_path + '/' + image_src
+          @columns_width = layout.columns[0].width
+          pdf.image image_path, width: @columns_width, position: :center
+          pdf.move_down 15
+          draw_caption(caption)
+        end
+
+        def draw_caption(caption)
+          top_left = [pdf.bounds.left + 20, pdf.cursor]
+          pdf.bounding_box(top_left, width: @columns_width - 40) do
+            # spin up a new renderer since this is called within one and Redcarpet
+            # doesn't allow this: https://github.com/vmg/redcarpet/issues/318
+            caption_content caption
+          end
+        end
+
+        def caption_content(caption)
+          pdf.stroke_bounds
+          pdf.move_down 15
+          text_renderer.render(caption)
+          pdf.move_down 36
+        end
+      end
+    end
+  end
+end

data/lib/bread/basket/poster/block_renderer.rb

@@ -0,0 +1,14 @@
+module Bread
+  module Basket
+    module Poster
+      class BlockRenderer < TextRenderer
+        attr_reader :pdf, :layout
+
+        # create pdf bounding box
+        def header(_text, _header_level)
+          # needs to be scss aware
+        end
+      end
+    end
+  end
+end

data/lib/bread/basket/poster/box.rb

@@ -0,0 +1,119 @@
+module Bread
+  module Basket
+    module Poster
+      class Box
+        include UnitsHelper
+        # Box does most of the heavy lifting of the self-referential css
+        # so it's a little confusing. It passes dimensions off to the dimensions
+        # helper and holds the methods for setting dimensions as either pending
+        # or determined and how to resolve those issues.
+        attr_reader :selector_name, :method_name, :layout, :specs,
+                    :pending, :unfinished, :styles
+        attr_accessor :top, :left, :width, :height, :bottom, :right, :stretchy,
+                      :content
+
+        def initialize(name, layout, specs = {})
+          fetch_names(name)
+          @layout = layout
+          @specs = specs
+          @styles = specs
+          @pending = []
+          @unfinished = []
+
+          setup_dimensions
+          layout.image_boxes << method_name if self.is_a? ImageBox
+          layout.boxes << selector_name
+        end
+
+        def fetch_names(name)
+          @selector_name = name
+          @method_name = name.sub('.', '').gsub('-', '_')
+        end
+
+        def setup_dimensions
+          DimensionsHelper.new(self, layout, specs)
+          layout.pending << selector_name unless pending.empty?
+        end
+
+        def try_to_resolve
+          pending.each do |dimension|
+            hash = send dimension
+            try_dimension hash
+            resolve_dimension(dimension, hash) if ready_to_resolve? hash
+          end
+        end
+
+        def try_dimension(dimensions_hash)
+          dimensions_hash[:pending].delete_if do |dimension_key, index|
+            value = layout.determined[dimension_key]
+            if value && value != :stretchy
+              command_arr = dimensions_hash[:command]
+              command_arr[index] = value
+            end
+          end
+        end
+
+        def resolve_dimension(dimension, hash)
+          command_string = hash[:command].join(' ')
+          value = eval command_string
+          instance_variable_set "@#{dimension}", value
+          pending.delete dimension
+          add_to_determined dimension, value
+          resolve_box if pending.empty?
+        end
+
+        def ready_to_resolve?(hash)
+          hash[:pending].empty? && safe?(hash[:command])
+        end
+
+        def safe?(command_array)
+          command_array.all? do |elem|
+            (elem.is_a? Numeric) || ([:+, :-, :/, :*, '(', ')'].include?(elem))
+          end
+        end
+
+        def add_to_determined(dimension_name, value)
+          name = method_name + '.' + dimension_name
+          instance_variable_set "@#{dimension_name}", value
+          layout.determined[name] = value
+        end
+
+        def resolve_box
+          layout.pending.delete selector_name
+          unfinished.each { |dimension| determine_missing dimension }
+        end
+        # Rubocop hates determine_missing
+        # rubocop:disable all
+        def determine_missing(missing_dimension)
+          value = case missing_dimension
+                  when 'left'
+                    right - width
+                  when 'right'
+                    left + width
+                  when 'width'
+                    right - left
+                  when 'top'
+                    bottom + height
+                  when 'height'
+                    top - bottom
+                  when 'bottom'
+                    top - height
+                  end
+          add_to_determined missing_dimension, value
+        end
+        # rubocop:enable all
+        def inspect
+          str = ''
+          %w(top left width height bottom right).each do |dim|
+            str << "#{dim}: #{send(dim)}; "
+          end
+          str.strip
+        end
+
+        def stretchy?
+          !stretchy.nil?
+        end
+      end
+    end
+  end
+end