wingtips 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: cd5429f39cdabf82c98b720de0920b7a6fedd089
-  data.tar.gz: b5d697a68077b2b9c887d3f516fca620ccfcdedc
+  metadata.gz: b3067ec6dfd19a143b1e7917681d7e69505d22b5
+  data.tar.gz: fd6ee01d3dbeb0721c17488dbd153221e5b6d1de
 SHA512:
-  metadata.gz: de4609a436f831be9af71febdff06fc086d2cc7a901c84137e65fe787aeba00237b5021ebc81365664af3bf753da4674ec50e7d65a2f3917d210a0ded9d1e640
-  data.tar.gz: dc4b09eae42b9a318c13e79bad2358e5870071c29c98b1b5086bf88c69475a7c596dd8f38780e2fa3ab733b2e39dffdf9f82b95383109b021b1a8fde2c3e77c8
+  metadata.gz: 796dce4c1700cfaac15bc61049cc6f0dc91ba33d59e37faa08dcb2320e5f792724faf1169c2c4413bb1a7647e9c119f60923769509147bce20d3d2d1fe35467a
+  data.tar.gz: d70487b4354d4928adfe3586dfcfbc678ddeb0a3283fa2f2dcc0196f5cfdd6249217fda76c1eed6a8a51c5c7b49f8f60b64bebf8c444517fc19b7488b83549df

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--require spec_helper

data/lib/wingtips.rb

@@ -1,6 +1,7 @@
 require 'shoes'
 require 'shoes/highlighter'
 
+require 'wingtips/hash_utils'
 require 'wingtips/version'
 require 'wingtips/slide'
 require 'wingtips/presentation'

data/lib/wingtips/configuration.rb

@@ -2,16 +2,21 @@ module Wingtips
   class Configuration
     include DSL
 
-    attr_reader :slide_classes, :app_options
+    attr_reader :slide_classes
 
     def initialize(path)
       self.class.current = self
-      @app_options = {
-        title:      'Presentation',
-        fullscreen: true
+      @wingtips_options = {
+        app: {
+          title:      'Presentation',
+          fullscreen: true
+        },
+        templates: {}
       }
 
+
       full_path = File.expand_path(path)
+      load_options(full_path)
       load_templates full_path
       load_named_slides full_path
 
@@ -22,8 +27,37 @@ module Wingtips
       self.instance_eval(File.read(full_path))
     end
 
-    def startup_options(opts={})
-      @app_options.merge!(opts)
+    def load_options(full_path)
+      begin
+        @allow_unnamed_slides = true
+        self.instance_eval(File.read(full_path))
+      rescue NameError
+        @allow_unnamed_slides = false
+        # expected to hit the first slide class and then abort evaling
+        # the config file. This is necessary so we can have the options at the
+        # beginning of the config file while they are needed in the tamplates
+        # for instance. So what happens is:
+        # 1. read config (options should be on top)
+        # 2. error upon encountering the first class, continue in initialize
+        # 3. Load slides and templates (while options are already loaded)
+        # 4. eval the config file again (options are read again, shouldn't be
+        #   a problem). This time no error as slide and template classes are
+        #   loaded
+        # Yes there could be a separate options file, but it didn't feel right
+        # to have a config and an options file
+      end
+    end
+
+    def app_options
+      @wingtips_options[:app]
+    end
+
+    def template_options
+      @wingtips_options[:templates]
+    end
+
+    def wingtips_options(opts={})
+      HashUtils.deep_merge! @wingtips_options, opts
     end
 
     def slides(*slide_classes)

data/lib/wingtips/hash_utils.rb

@@ -0,0 +1,19 @@
+module Wingtips
+  module HashUtils
+    extend self
+
+    def deep_merge(hash1, hash2)
+      deep_merge!(hash1.dup, hash2)
+    end
+
+    def deep_merge!(hash1, hash2)
+      hash1.merge! hash2 do |_key, value1, value2|
+        if value1.respond_to?(:merge!) && value2.respond_to?(:merge!)
+          HashUtils.deep_merge! value1, value2
+        else
+          value2
+        end
+      end
+    end
+  end
+end

data/lib/wingtips/presentation.rb

@@ -9,12 +9,21 @@ module Wingtips
 
       Shoes.app(config.app_options) do
         @slides = slides
+        @wingtips_options = config.wingtips_options
+        @code_highlighting = Shoes::Highlighter::Markup::COLORS
+        if @wingtips_options[:code_highlighting]
+          @code_highlighting = @code_highlighting.merge @wingtips_options[:code_highlighting]
+        end
 
         def start
           setup_controls
           go_to_slide(0)
         end
 
+        def code_highlighting
+          @code_highlighting
+        end
+
         def on_slide_change(&block)
           @on_slide_change_block = block
         end
@@ -29,7 +38,7 @@ module Wingtips
 
           @current_slide_number = number.to_i
           slide_class = @slides[@current_slide_number]
-          @current_slide = slide_class.new(app)
+          @current_slide = slide_class.new(app, @wingtips_options)
           @current_slide.show
         end
 

data/lib/wingtips/slide.rb

@@ -16,9 +16,10 @@ module Wingtips
 
     attr_reader :app
 
-    def initialize(app)
+    def initialize(app, wingtips_options = {})
       @app = app
       @effects = []
+      @background_color = wingtips_options[:background_color]
       after_initialize
     end
 
@@ -28,6 +29,7 @@ module Wingtips
 
     def show
       @main_slot = stack height: app.height do
+        background @background_color if @background_color
         content
       end
     end
@@ -46,10 +48,11 @@ module Wingtips
       end
     end
 
-    def code(string, demo_as_effect = false, &block)
+    def code(string, demo_as_effect = false, options = {}, &block)
       source = source_from string
       source = source.split("\n").map{|line| '     ' + line}.join("\n")
-      highlighted_code = para *highlight(source), size: CODE_SIZE
+      opts = {size: CODE_SIZE}.merge options
+      highlighted_code = para *highlight(source, nil, @app.code_highlighting), opts
       add_demo_as_effect(source, &block) if demo_as_effect
       highlighted_code
     end
@@ -126,6 +129,7 @@ module Wingtips
     def scale_image_by(img, ratio)
       img.width = (img.width * ratio).to_i
       img.height = (img.height * ratio).to_i
+      img
     end
 
     def centered_title(string, opts={})

data/lib/wingtips/version.rb

@@ -1,3 +1,3 @@
 module Wingtips
-  VERSION = "0.1.0"
+  VERSION = "0.2.0"
 end

data/samples/wingtips_introduction/config.rb

@@ -1,4 +1,24 @@
 # Arrange the order of your slides here
+wingtips_options background_color: Shoes::COLORS[:white],
+                code_highlighting: {
+                    comment:   { stroke: "#887" },
+                    keyword:   { stroke: Shoes::COLORS[:navy], weight: 'bold' },
+                    method:    { stroke: Shoes::COLORS[:black], weight: 'bold' },
+                    symbol:    { stroke: Shoes::COLORS[:darkviolet], weight: 'bold' },
+                    string:    { stroke: Shoes::COLORS[:forestgreen], weight: 'bold' },
+                    number:    { stroke: Shoes::COLORS[:steelblue], weight: 'bold' },
+                    regex:     { stroke: "#000", fill: "#FFC" },
+                    attribute: { stroke: Shoes::COLORS[:darkviolet], weight: 'bold' },
+                    expr:      { stroke: "#722", weight: 'bold' },
+                    ident:     { stroke: "#994c99", weight: 'bold' },
+                    constant:  { stroke: Shoes::COLORS[:darkviolet], weight: "bold" },
+                    class:     { stroke: Shoes::COLORS[:darkviolet], weight: "bold" },
+                    matching:  { stroke: "#ff0", weight: "bold" },
+                },
+                app: {
+                  title: 'Wingtips introduction!'
+                }
+
 slides Hello, Bullets, DSLSlide, Images, FullScreenImage, FullyShownImage, Code,
        CodeExecute, HowDoesThisWork
        
@@ -10,6 +30,11 @@ code = <<-CODE
 class MyClass
   def fancy_method
     magic!
+    5 + 5
+    :symbol
+    COLOR
+    OtherClass
+    @conference
   end
 end
 CODE

data/spec/spec_helper.rb

@@ -0,0 +1,93 @@
+require 'wingtips'
+
+# This file was generated by the `rspec --init` command. Conventionally, all
+# specs live under a `spec` directory, which RSpec adds to the `$LOAD_PATH`.
+# The generated `.rspec` file contains `--require spec_helper` which will cause
+# this file to always be loaded, without a need to explicitly require it in any
+# files.
+#
+# Given that it is always loaded, you are encouraged to keep this file as
+# light-weight as possible. Requiring heavyweight dependencies from this file
+# will add to the boot time of your test suite on EVERY test run, even for an
+# individual file that may not need all of that loaded. Instead, consider making
+# a separate helper file that requires the additional dependencies and performs
+# the additional setup, and require it from the spec files that actually need
+# it.
+#
+# The `.rspec` file also contains a few flags that are not defaults but that
+# users commonly want.
+#
+# See http://rubydoc.info/gems/rspec-core/RSpec/Core/Configuration
+RSpec.configure do |config|
+  # rspec-expectations config goes here. You can use an alternate
+  # assertion/expectation library such as wrong or the stdlib/minitest
+  # assertions if you prefer.
+  config.expect_with :rspec do |expectations|
+    # This option will default to `true` in RSpec 4. It makes the `description`
+    # and `failure_message` of custom matchers include text for helper methods
+    # defined using `chain`, e.g.:
+    #     be_bigger_than(2).and_smaller_than(4).description
+    #     # => "be bigger than 2 and smaller than 4"
+    # ...rather than:
+    #     # => "be bigger than 2"
+    expectations.include_chain_clauses_in_custom_matcher_descriptions = true
+  end
+
+  # rspec-mocks config goes here. You can use an alternate test double
+  # library (such as bogus or mocha) by changing the `mock_with` option here.
+  config.mock_with :rspec do |mocks|
+    # Prevents you from mocking or stubbing a method that does not exist on
+    # a real object. This is generally recommended, and will default to
+    # `true` in RSpec 4.
+    mocks.verify_partial_doubles = true
+  end
+
+# The settings below are suggested to provide a good initial experience
+# with RSpec, but feel free to customize to your heart's content.
+=begin
+  # These two settings work together to allow you to limit a spec run
+  # to individual examples or groups you care about by tagging them with
+  # `:focus` metadata. When nothing is tagged with `:focus`, all examples
+  # get run.
+  config.filter_run :focus
+  config.run_all_when_everything_filtered = true
+
+  # Limits the available syntax to the non-monkey patched syntax that is
+  # recommended. For more details, see:
+  #   - http://myronmars.to/n/dev-blog/2012/06/rspecs-new-expectation-syntax
+  #   - http://teaisaweso.me/blog/2013/05/27/rspecs-new-message-expectation-syntax/
+  #   - http://myronmars.to/n/dev-blog/2014/05/notable-changes-in-rspec-3#new__config_option_to_disable_rspeccore_monkey_patching
+  config.disable_monkey_patching!
+
+  # This setting enables warnings. It's recommended, but in some cases may
+  # be too noisy due to issues in dependencies.
+  config.warnings = true
+
+  # Many RSpec users commonly either run the entire suite or an individual
+  # file, and it's useful to allow more verbose output when running an
+  # individual spec file.
+  if config.files_to_run.one?
+    # Use the documentation formatter for detailed output,
+    # unless a formatter has already been configured
+    # (e.g. via a command-line flag).
+    config.default_formatter = 'doc'
+  end
+
+  # Print the 10 slowest examples and example groups at the
+  # end of the spec run, to help surface which specs are running
+  # particularly slow.
+  config.profile_examples = 10
+
+  # Run specs in random order to surface order dependencies. If you find an
+  # order dependency and want to debug it, you can fix the order by providing
+  # the seed, which is printed after each run.
+  #     --seed 1234
+  config.order = :random
+
+  # Seed global randomization in this process using the `--seed` CLI option.
+  # Setting this allows you to use `--seed` to deterministically reproduce
+  # test failures related to randomization by passing the same `--seed` value
+  # as the one that triggered the failure.
+  Kernel.srand config.seed
+=end
+end

data/spec/wingtips/hash_utils_spec.rb

@@ -0,0 +1,52 @@
+require 'spec_helper'
+
+RSpec.describe Wingtips::HashUtils do
+  describe '.deep_merge' do
+    it 'merges non conflicting hashes okay' do
+      result = Wingtips::HashUtils.deep_merge({a: 1}, {b:2})
+      expect(result).to eq({a:1, b:2})
+    end
+
+    it 'resolves easy conflicts ok' do
+      result = Wingtips::HashUtils.deep_merge({a: 1}, {a: 20})
+      expect(result).to eq({a: 20})
+    end
+
+    it 'merges hashes fine one step down' do
+      result = Wingtips::HashUtils.deep_merge({app: {fullscreen: true}},
+                               {app: {title: 'lala'}})
+      expect(result).to eq({app: {fullscreen: true, title: 'lala'}})
+    end
+
+    it 'merges them fine even 3 steps down' do
+      result = Wingtips::HashUtils.deep_merge({a: {b: {c: {d: 1, e: 5}}}},
+                                    {a: {b: {c: {d: 20, f: 9}}}})
+      expect(result).to eq({a: {b: {c: {d: 20, e: 5, f:9}}}})
+    end
+
+    it 'does not modify the first hash' do
+      first = {a: 5}
+      Wingtips::HashUtils.deep_merge first, {b: 7}
+      expect(first).to eq({a: 5})
+    end
+
+    it 'can merge with a frozen hash' do
+      frozen = {a: 7}.freeze
+      result = Wingtips::HashUtils.deep_merge frozen, {a: 20}
+      expect(result).to eq({a: 20})
+    end
+  end
+
+  describe '.deep_merge!' do
+    it 'modifies the first hash' do
+      first = {a: 5}
+      Wingtips::HashUtils.deep_merge! first, {b: 7}
+      expect(first).to eq({a: 5, b: 7})
+    end
+
+    it 'raises an error when trying to merge in a frozen hash' do
+      frozen = {a: 5}.freeze
+      expect {Wingtips::HashUtils.deep_merge! frozen, {a: 20}}.to raise_error
+    end
+  end
+end

data/wingtips.gemspec

@@ -6,7 +6,7 @@ require 'wingtips/version'
 Gem::Specification.new do |spec|
   spec.name          = "wingtips"
   spec.version       = Wingtips::VERSION
-  spec.authors       = ['Tobias Pfiffer', 'Jason R. Clark']
+  spec.authors       = ['Tobias Pfeiffer', 'Jason R. Clark']
   spec.email         = ['pragtob@gmail.com', 'jason@jasonrclark.net']
   spec.summary       = %q{Presentation software for Shoes}
   spec.description   = %q{Put your best foot forward, present with Shoes!}
@@ -19,9 +19,10 @@ Gem::Specification.new do |spec|
   spec.require_paths = ["lib"]
 
   spec.add_dependency "shoes", "~> 4.0.0.pre3"
-  spec.add_dependency "shoes-highlighter", "~> 1.0.0"
+  spec.add_dependency "shoes-highlighter", "~> 1.0.1"
 
   spec.add_development_dependency "bundler", "~> 1.7"
   spec.add_development_dependency "rake",    "~> 10.0"
   spec.add_development_dependency "pry",     "~> 0.10.0"
+  spec.add_development_dependency "rspec",     "~> 3.2"
 end

metadata

@@ -1,15 +1,15 @@
 --- !ruby/object:Gem::Specification
 name: wingtips
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
-- Tobias Pfiffer
+- Tobias Pfeiffer
 - Jason R. Clark
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2015-03-16 00:00:00.000000000 Z
+date: 2015-04-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: shoes
@@ -31,12 +31,12 @@ dependencies:
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: 1.0.0
+        version: 1.0.1
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: 1.0.0
+        version: 1.0.1
   prerelease: false
   type: :runtime
 - !ruby/object:Gem::Dependency
@@ -81,6 +81,20 @@ dependencies:
         version: 0.10.0
   prerelease: false
   type: :development
+- !ruby/object:Gem::Dependency
+  name: rspec
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.2'
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.2'
+  prerelease: false
+  type: :development
 description: Put your best foot forward, present with Shoes!
 email:
 - pragtob@gmail.com
@@ -91,6 +105,7 @@ extensions: []
 extra_rdoc_files: []
 files:
 - .gitignore
+- .rspec
 - .ruby-gemset
 - .ruby-version
 - Gemfile
@@ -101,6 +116,7 @@ files:
 - lib/wingtips.rb
 - lib/wingtips/configuration.rb
 - lib/wingtips/dsl.rb
+- lib/wingtips/hash_utils.rb
 - lib/wingtips/presentation.rb
 - lib/wingtips/slide.rb
 - lib/wingtips/version.rb
@@ -111,6 +127,8 @@ files:
 - samples/wingtips_introduction/slides/how_does_this_work.rb
 - samples/wingtips_introduction/slides/my_slides.rb
 - samples/wingtips_introduction/templates/code_template.rb
+- spec/spec_helper.rb
+- spec/wingtips/hash_utils_spec.rb
 - wingtips.gemspec
 homepage: https://github.com/PragTob/wingtips
 licenses:
@@ -136,4 +154,6 @@ rubygems_version: 2.4.5
 signing_key:
 specification_version: 4
 summary: Presentation software for Shoes
-test_files: []
+test_files:
+- spec/spec_helper.rb
+- spec/wingtips/hash_utils_spec.rb