bread-basket 0.0.0 → 0.0.1

data/samples/sample.md

@@ -0,0 +1,59 @@
+---
+stylesheet: example_flow
+title: Comparison of Pre-interpolation Algorithms for k-Space regridding
+authors: KC Erb, Ganesh Adluru, Srikant Kamesh Iyer, Devavrat Likhite, John A Roberts, and Edward DiBella[2]
+affiliations:
+  - UCAIR, University of Utah, Salt Lake, Utah, United States
+  - Department of Radiology, University of Utah, Salt Lake, Utah, United States
+---
+
+# Formatting
+
+You note sections in your poster with the # sign. 1 # is the largest section
+size ## is next smallest ### next and so forth.
+
+To make text *italic* use one star, for **bold** use two. Underlines are hard
+to see on posters so if you _must_ use them it is done with underscores.
+
+You can include super and subscripts in your text. Superscript is just like you expect
+with a carat putting the rest of the characters following it up top: 10^21.
+Subscripts don't have a shortcut so you will have to use tags: sub<sub>script</sub>.
+
+You can make your text shine out with your accent color and weight with ==highlighting==.
+And you can get a different accent style with `code text markers`.
+
+
+# Sciency Things
+
+You can use equations in your document via LaTeX. You'll need to have
+`pdflatex` installed on your machine.
+
+```
+P = \frac{1}{\hbar \omega} \int ||D-gm||^2 dx
+```
+
+
+A figure is easy to include
+
+```figure:fig1-a.png
+  The caption goes in here. `2+2`
+```
+
+If you want to use a normal code block just leave off the figure keyword
+
+```ruby
+puts "Cool rad awesome!"
+```
+
+You can write up a spiffy table via normal markdown style
+
+| Tables        | Are           | Cool  |
+| ------------- |:-------------:| -----:|
+| col 3 is      | right-aligned | $1600 |
+| col 2 is      | centered      |   $12 |
+| zebra stripes | are neat      |    $1 |
+
+
+Ooh and a fancy feature is the pullquote:
+
+> This text will get pulled into its own quote if the template has a pullquote.

data/samples/simple.css

@@ -0,0 +1,19 @@
+.layout {
+  width: 4.ft;
+  height: 3.ft;
+  margin: 1.in;
+
+  font-size: 36;
+  font-family: helvetica;
+}
+
+.columns {
+  count: 4;
+  top: title.left + margin;
+}
+
+.left-logo {
+  src: ucair_logo.png;
+  top: top;
+  left: left;
+}

data/samples/simple.md

@@ -0,0 +1,3 @@
+---
+stylesheet: simple
+---

data/spec/cli_spec.rb

@@ -0,0 +1,13 @@
+# Some bare-bones CLI specs. At this point the CLI is so simple
+# I'm not sure that it needs real specs . . .
+
+describe Bread::Basket::Cli do
+  context 'poster' do
+    let(:file) { 'example.md' }
+
+    it 'gives file to Poster' do
+      expect(Bread::Basket::Poster::PosterMaker).to receive(:new).with(file)
+      subject.poster(file)
+    end
+  end
+end

data/spec/poster/block_code_handler_spec.rb

@@ -0,0 +1,47 @@
+describe Bread::Basket::Poster::BlockCodeHandler do
+  let(:pdf) { Prawn::Document.new }
+  # explanation of before(:all) in css_reader_spec
+  context 'when used to create images' do
+    let(:first_line) { 'dragon.png' }
+    let(:content) { "Here's a *caption* with **markdown**" }
+
+    before(:each) do
+      metadata = { 'stylesheet' => 'block_code_test'  }
+      Bread::Basket::Poster.dir_path = './spec/poster/test_files'
+      @layout = Bread::Basket::Poster::Layout.new(metadata)
+      Bread::Basket::Poster.layout = @layout
+      Bread::Basket::Poster.pdf = pdf
+    end
+
+    subject do
+      Bread::Basket::Poster::BlockCodeHandler.new(pdf, @layout, first_line, content)
+    end
+
+    # yeah sorta bare bones here, open to suggestions
+    it 'doesnt fail' do
+      subject
+    end
+  end
+
+  context 'when given a bad first line' do
+    let(:first_line) { 'bleh' }
+    let(:content) { 'Feed me!' }
+
+    before(:each) do
+      metadata = { 'stylesheet' => 'block_code_test'  }
+      Bread::Basket::Poster.dir_path = './spec/poster/test_files'
+      @layout = Bread::Basket::Poster::Layout.new(metadata)
+      Bread::Basket::Poster.layout = @layout
+      Bread::Basket::Poster.pdf = pdf
+    end
+
+    subject do
+      Bread::Basket::Poster::BlockCodeHandler.new(pdf, @layout, first_line, content)
+    end
+
+    # yeah sorta bare bones here, open to suggestions
+    it 'doesnt fail' do
+      subject
+    end
+  end
+end

data/spec/poster/box_spec.rb

@@ -0,0 +1,114 @@
+describe Bread::Basket::Poster::Box do
+  # explanation of before all in css_reader_spec
+  before(:all) do
+    metadata = { 'stylesheet' => 'self_referential'  }
+    Bread::Basket::Poster.dir_path = './spec/poster/test_files'
+    @name = '.simple-selector'
+    @layout = Bread::Basket::Poster::Layout.new(metadata)
+  end
+
+  describe 'css_reader sets up columns[0] correctly via reference' do
+    subject { @layout.columns[0] }
+    its(:top)    { should eq(500) }
+    its(:height) { should eq(495) }
+  end
+
+  describe 'css_reader leaves columns[1] pending due to stretchy dependence' do
+    subject { @layout.columns[1] }
+    its(:top)  do
+      # There are a few things hiding here, it converts the command name from - to _
+      # and it correctly inserts margin as 5.0
+      h = { pending: { 'stretchy_box.bottom' => 0 },
+            command: ['stretchy_box.bottom', :-, 5.0]
+          }
+      should eq h
+    end
+    its(:height) { should be_nil }
+  end
+
+  context 'interdependent self-reference' do
+    describe 'box a' do
+      subject { @layout.box_a }
+      its(:left)   { should eq 200 }
+      its(:height) { should eq 125 }
+    end
+
+    describe 'box b' do
+      subject { @layout.box_b }
+      its(:top)    { should eq 700 }
+      its(:height) { should eq 125 }
+    end
+
+    describe 'box c' do
+      subject { @layout.box_c }
+      its(:left)  { should eq 200 }
+      its(:top)   { should eq 700 }
+    end
+  end
+
+  describe 'math operations' do
+    subject { @layout.math }
+    its(:left)  { should eq 10 }
+    its(:top)   { should eq 580 }
+    its(:width)   { should eq 185 }
+    its(:height)   { should eq 520.0 / 3 }
+  end
+
+  it 'inspects itself' do
+    inspect_string = 'top: 700.0; left: 200.0; width: 500.0; height: 200.0; ' \
+                      'bottom: 500.0; right: 700.0;'
+    expect(@layout.simple_box.inspect).to eq inspect_string
+  end
+
+  context 'when unusual bounds are given' do
+    describe 'no width' do
+      subject { @layout.no_width }
+      its(:width)  { should eq 100 }
+    end
+
+    describe 'no left' do
+      subject { @layout.no_left }
+      its(:left)  { should eq 1000 }
+    end
+
+    describe 'no top' do
+      subject { @layout.no_top }
+      its(:top)  { should eq 55 }
+    end
+
+    describe 'top and height' do
+      subject { @layout.top_and_height }
+      its(:top)  { should eq 70 }
+      its(:height)  { should eq 55 }
+      its(:bottom)  { should eq 15 }
+    end
+
+    describe 'when horizontally overdetermined' do
+      subject { @layout.horizontally_overdetermined }
+      it 'ignores the `right` specification' do
+        expect(subject.right).to eq 330
+      end
+    end
+
+    describe 'when vertically overdetermined' do
+      subject { @layout.vertically_overdetermined }
+      it 'ignores the `bottom` specification' do
+        expect(subject.bottom).to eq 43
+      end
+    end
+
+    describe 'when making a box with insufficient inputs' do
+      subject { Bread::Basket::Poster::Box.new('.bread-box', @layout, @specs) }
+
+      it 'fails if only 1 of left, right or width are given' do
+        @specs = { 'left' => 15, 'top' => 33 }
+        expect { subject }.to raise_error SystemExit
+      end
+
+      it 'fails if no top, but only bottom or height given' do
+        @specs = { 'left' => 52, 'width' => 15, 'bottom' => 20 }
+        expect { subject }.to raise_error SystemExit
+      end
+    end
+  end
+end

data/spec/poster/columns_spec.rb

@@ -0,0 +1,64 @@
+describe Bread::Basket::Poster::Columns do
+  # explanation of before all in css_reader_spec
+  before(:all) do
+    metadata = { 'stylesheet' => 'basic_flow'  }
+    Bread::Basket::Poster.dir_path = './spec/poster/test_files'
+    @layout = Bread::Basket::Poster::Layout.new(metadata)
+  end
+
+  it 'quits if specs are wrong' do
+    specs = { 'left' => 2, 'top' => 40, 'width' => 100 }
+    expect do
+      Bread::Basket::Poster::Columns.new specs, @layout
+    end.to raise_error SystemExit
+  end
+
+  it 'duplicates tops into an array of length count' do
+    specs = { 'count' => 2, 'top' => 40 }
+    columns = Bread::Basket::Poster::Columns.new specs, @layout
+    expect(columns.tops).to eq [40, 40]
+  end
+
+  it 'uses top array as-is if count matches tops arr length' do
+    specs = { 'count' => 2, 'top' => [37, 25] }
+    columns = Bread::Basket::Poster::Columns.new specs, @layout
+    expect(columns.tops).to eq [37, 25]
+  end
+
+  it 'makes symmetric tops for even column number' do
+    specs = { 'count' => 4, 'top' => [40, 10] }
+    columns = Bread::Basket::Poster::Columns.new specs, @layout
+    expect(columns.tops).to eq [40, 10, 10, 40]
+  end
+
+  it 'makes symmetric tops for odd column number' do
+    specs = { 'count' => 5, 'top' => [40, 10, 30] }
+    columns = Bread::Basket::Poster::Columns.new specs, @layout
+    expect(columns.tops).to eq [40, 10, 30, 10, 40]
+  end
+
+  it 'uses layout font to determine column spacing and widths' do
+    specs = { 'count' => 5, 'top' => [40, 10, 30] }
+    columns = Bread::Basket::Poster::Columns.new specs, @layout
+    expect(columns.width).to eq 194.8
+  end
+
+  it 'fails to create symmetric tops for top input' do
+    specs = { 'count' => 4, 'top' => [40, 10, 30] }
+    expect do
+      Bread::Basket::Poster::Columns.new specs, @layout
+    end.to raise_error SystemExit
+  end
+
+  it 'uses columns font-size for spacing if provided' do
+    specs = { 'count' => 5, 'top' => [40, 10, 30], 'font-size' => 37 }
+    columns = Bread::Basket::Poster::Columns.new specs, @layout
+    expect(columns.spacing).to eq 37
+  end
+
+  it 'uses layout font-size for spacing if no font-size specified' do
+    specs = { 'count' => 5, 'top' => [40, 10, 30] }
+    columns = Bread::Basket::Poster::Columns.new specs, @layout
+    expect(columns.spacing).to eq 24
+  end
+end

data/spec/poster/css_reader_spec.rb

@@ -0,0 +1,115 @@
+describe Bread::Basket::Poster::CSSReader do
+  # This will actually run through all kinds of boxes, dimensions helpers
+  # and the like, but I'm trying to only spec out the jobs of css_reader.
+  context 'when given the basic_flow stylesheet' do
+    # Using a before block here because I want to alter the load path without
+    # actually loading a markdown file from the start. Layout needs a real css
+    # file to talk to in order to initialize correctly.
+    before(:all) do
+      metadata = { 'stylesheet' => 'basic_flow'  }
+      Bread::Basket::Poster.dir_path = './spec/poster/test_files'
+      @layout = Bread::Basket::Poster::Layout.new(metadata)
+    end
+
+    describe 'css_reader sets up the layout properties' do
+      subject { @layout }
+      its(:top)    { should eq(720) }
+      its(:bottom) { should eq(0) }
+      its(:height) { should eq(720) }
+      its(:left)   { should eq(0) }
+      its(:right)  { should eq(1080) }
+      its(:width)  { should eq(1080) }
+
+      its(:font_size)  { should eq(24) }
+      its(:font_family)  { should eq('times') }
+      its(:boxes) do
+        boxes = %w(columns[0] columns[1] columns[2] columns[3] .stretchy-box .image)
+        should eq boxes
+      end
+    end
+
+    describe 'css_reader sets up columns[0]' do
+      subject { @layout.columns[0] }
+      its(:top)    { should eq(648) }
+      its(:bottom) { should eq(5) }
+      its(:height) { should eq(643) }
+      its(:left)   { should eq(5) }
+      its(:right)  { should eq(254.5) }
+      its(:width)  { should eq(249.5) }
+    end
+
+    describe 'css_reader sets up columns[1]' do
+      subject { @layout.columns[1] }
+      its(:top)    { should eq(576) }
+      its(:bottom) { should eq(5) }
+      its(:height) { should eq(571) }
+      its(:left)   { should eq(278.5) }
+      its(:right)  { should eq(528) }
+      its(:width)  { should eq(249.5) }
+    end
+
+    describe 'css_reader sets up the bounds for stretchy box' do
+      subject { @layout.stretchy_box }
+      its(:top)    { should eq(100) }
+      its(:bottom) { should eq(:stretchy) }
+      its(:height) { should eq(:stretchy) }
+      its(:left)   { should eq(200) }
+      its(:right)  { should eq(700) }
+      its(:width)  { should eq(500) }
+      it 'has font-size style' do
+        font_size = subject.styles['font-size']
+        expect(font_size).to eq 22
+      end
+    end
+
+    describe 'css_reader sets up the bounds for image' do
+      subject { @layout.image }
+      its(:top)    { should eq(720) }
+      its(:bottom) { should eq(308) }
+      its(:height) { should eq(412) }
+      its(:left)   { should eq(576) }
+      its(:right)  { should eq(1080) }
+      its(:width)  { should eq(504) }
+    end
+
+    describe 'css_reader creates header style' do
+      subject { @layout.header }
+      it 'should have background color in its hash' do
+        expect(subject['background-color']).to eq('#ffffff')
+      end
+    end
+
+    describe "css_reader's other functions" do
+      subject { @layout.css_reader }
+
+      it 'convert string css rules string into hash of strings' do
+        css_rules = 'bread: howdy; basket: belly'
+        specs_hash = { 'bread' => 'howdy', 'basket' => 'belly' }
+        expect(subject.rules_to_specs(css_rules)).to eq specs_hash
+      end
+
+      it 'convert css rules with commas into hash of arrays' do
+        css_rules = 'bread: howdy, belly'
+        specs_hash = { 'bread' => %w(howdy belly) }
+        expect(subject.rules_to_specs(css_rules)).to eq specs_hash
+      end
+
+      it 'convert selector names into valid ruby names' do
+        selector_name = '#a-nice-name.'
+        method_name = 'a_nice_name'
+        expect(subject.to_method_name(selector_name)).to eq method_name
+      end
+    end
+  end
+
+  context 'when given the basic_block stylesheet' do
+    it 'fails if mismatch between css and layout type' do
+      metadata = { 'stylesheet' => 'basic_block', 'layout' => 'flow'  }
+      Bread::Basket::Poster.dir_path = './spec/poster/test_files'
+
+      expect do
+        Bread::Basket::Poster::Layout.new(metadata)
+      end.to raise_error SystemExit
+    end
+  end
+end

data/spec/poster/header_maker_spec.rb

@@ -0,0 +1,49 @@
+describe Bread::Basket::Poster::HeaderMaker do
+  let(:pdf) {  Prawn::Document.new }
+  # explanation of before(:all) in css_reader_spec
+  context 'when header selector is missing' do
+    let(:metadata) { { 'stylesheet' => 'nearly_empty'  } }
+    let(:layout) { Bread::Basket::Poster::Layout.new(metadata) }
+
+    before(:each) do
+      Bread::Basket::Poster.dir_path = './spec/poster/test_files'
+    end
+
+    subject { Bread::Basket::Poster::HeaderMaker.new(pdf, layout) }
+
+    it "doesn't fail" do
+      expect do
+        subject.create_header('Header', 'font-size' => 12)
+      end.not_to raise_error
+    end
+
+    it 'returns layout styles as empty hash' do
+      expect(subject.layout_styles).to eq({})
+    end
+  end
+
+  context 'when header styles are provided they override' do
+    let(:metadata) { { 'stylesheet' => 'header_test'  } }
+    let(:layout) { Bread::Basket::Poster::Layout.new(metadata) }
+    let(:header_maker) { Bread::Basket::Poster::HeaderMaker.new(pdf, layout) }
+
+    before(:each) do
+      Bread::Basket::Poster.dir_path = './spec/poster/test_files'
+      styles = Bread::Basket::Poster.current_styles
+      header_maker.create_header('Header', styles)
+    end
+
+    subject { header_maker.styles }
+
+    its(['width'])  { should eq(300) }
+    its(['height']) { should eq(55) }
+
+    its(['font-size'])        { should eq(73) }
+    its(['color'])            { should eq('#cc00FF') }
+    its(['margin-top'])       { should eq(13) }
+    its(['margin-bottom'])    { should eq(17) }
+    its(['radius'])           { should eq(11) }
+    its(['background-color']) { should eq('#000000') }
+    its(['font-family'])      { should eq('Courier') }
+  end
+end