shipyard-framework 0.5.1 → 0.5.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 012416749336816965f8232bd66ce83714e27efd
-  data.tar.gz: 75d164a2deb0985740166e01efa83851a7f4409c
+  metadata.gz: 4583619f521de770f88cc5a90546c0be4176ddf5
+  data.tar.gz: 00e8b03081f2ea05bfbaf8b0a84870772f1694d2
 SHA512:
-  metadata.gz: 95a4fa016cd9f1bbd0be6a71399286e3ff456e4c73112f5acc3b37b3fbc9a1dcaa19a215b6139420815672df2edb43d3e751f7f580db7c23c953c207774260df
-  data.tar.gz: e4df0db55dca161de2a38dd16fcfad5cd50d1b338e65cfe3f6d0d80281af2831c121ab5778a168f311b46c58c43b680e83489bc38c834e26f4ac2cd9b7e3711e
+  metadata.gz: d4906eb002f3bf282fd0d81a208c09eeddf09b80f57c21da1c4138e7637075b42346931be07f1ce1bded9d27b7111128f942e7ece72f6b1803ee427b4181738d
+  data.tar.gz: 4edd1a39ce05f5777bc029a194998fe867bc07f22f9e068d2fcb57e42a68c13125d1a922b633bcc5a1c0bc8df454bf2547eb66417e487118f095c7ce9c0cbb3b

data/.rspec

@@ -1,2 +1,3 @@
 --format documentation
---color
+--color                                                                                                        
+--require spec_helper

data/.ruby-version

@@ -0,0 +1 @@
+2.4.1

data/README.md

@@ -32,6 +32,10 @@ plugins:
   - shipyard-framework
 ```
 
+## Status
+[![Gem Version](https://badge.fury.io/rb/shipyard-framework.svg)](https://badge.fury.io/rb/shipyard-framework)
+[![Codeship Status for shipyard-framework/shipyard](https://app.codeship.com/projects/a1a079a0-800a-0135-2025-3e18bae1bf89/status?branch=master)](https://app.codeship.com/projects/246583)
+
 ## Usage
 
 TODO: Write usage instructions here
@@ -46,7 +50,6 @@ To install this gem onto your local machine, run `bundle exec rake install`. To
 
 Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/shipyard. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
 
-
 ## License
 
 The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).

data/app/helpers/shipyard/alert_helper.rb

@@ -23,7 +23,7 @@ module Shipyard
         end
       end
 
-      options[:class] = "#{class_list.join(' ')} #{options[:class]}"
+      options[:class] = "#{class_list.join(' ')} #{options[:class]}".strip
 
       content_tag :div, options do
         concat content_tag(:p, raw(alert_txt), class: 'alert-txt')

data/app/helpers/shipyard/button_helper.rb

@@ -1,6 +1,7 @@
 module Shipyard
   module ButtonHelper
     include ActionView::Helpers::TagHelper
+    include ActionView::Helpers::UrlHelper
 
     def btn(text, *args, &block)
       if block_given?

data/app/helpers/shipyard/form_helper.rb

@@ -1,14 +1,19 @@
 module Shipyard
   module FormHelper
+    include ActionView::Context
+    include ActionView::Helpers::FormTagHelper
+    include ActionView::Helpers::FormOptionsHelper
+
     def input_text(name, value=nil, options={})
-      options[:class] = "input input-text #{options[:class]}"
+      options[:class] = "input input-text #{options[:class]}".strip
       text_field_tag name, value, options
     end
 
     def input_select_tag(name, choices, container_options={}, select_options={})
-      container_options[:class] = "input-select-container #{container_options[:class]}"
+      container_options[:class] = "input-select-container #{container_options[:class]}".strip
       content_tag :div, container_options do
-        select_options[:class] = "input input-select #{select_options[:class]}"
+        select_options[:class] = "input input-select #{select_options[:class]}".strip
+        choices = options_for_select(choices) if choices.is_a? Array
         select_tag name, choices, select_options
       end
     end

data/lib/shipyard-framework.rb

@@ -12,6 +12,7 @@ module Shipyard
         register_jekyll_tags
       end
 
+      register_helpers
       configure_sass
     end
 
@@ -52,7 +53,6 @@ module Shipyard
 
     def configure_sass
       require 'sass'
-
       ::Sass.load_paths << stylesheets_path
     end
 
@@ -79,6 +79,12 @@ module Shipyard
       Liquid::Template.register_tag('alert', Shipyard::Jekyll::Alert)
       Liquid::Template.register_tag('shipyard_version', Shipyard::Jekyll::ShipyardVersion)
     end
+
+    def register_helpers
+      Dir['app/helpers/shipyard/*.rb'].each do |file|
+        require_relative "../#{file}"
+      end
+    end
   end
 end
 

data/lib/shipyard-framework/version.rb

@@ -1,3 +1,3 @@
 module Shipyard
-  VERSION = '0.5.1'
+  VERSION = '0.5.2'
 end

data/shipyard.gemspec

@@ -17,7 +17,9 @@ Gem::Specification.new do |spec|
   # spec.add_runtime_dependency 'sassc', '~> 1.11.4'
   spec.add_runtime_dependency 'actionview', '~> 5.0'
 
-  spec.add_development_dependency 'bundler', '~> 1.15', '>= 1.15.3'
+  spec.add_development_dependency 'bundler', '~> 1.15'
+  spec.add_development_dependency 'sass', '~> 3.5', '>= 3.5.1'
+  spec.add_development_dependency 'rspec', '~> 3.6'
 
   spec.executables = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
   spec.files = `git ls-files`.split("\n")

data/spec/helpers/alert_helper_spec.rb

@@ -0,0 +1,19 @@
+require 'spec_helper'
+
+RSpec.describe Shipyard::AlertHelper, type: :helper do
+  include Shipyard::AlertHelper
+
+  it 'should return a default alert' do
+    expect(flash_alert { 'test' }).to match(
+      %r{<div role="alert" data-shipyard="alert" v-show="visible" class="alert"><p class="alert-txt">test</p></div>}
+    )
+  end
+
+  it 'should return all alert types' do
+    %w(info success warning error).each do |type|
+      expect(flash_alert(type.to_sym) { type }).to match(
+        %r{<div role="alert" data-shipyard="alert" v-show="visible" class="alert alert-#{type}"><p class="alert-txt">#{type}</p></div>}
+      )
+    end
+  end
+end

data/spec/helpers/box_helper_spec.rb

@@ -0,0 +1,21 @@
+require 'spec_helper'
+
+RSpec.describe Shipyard::BoxHelper, type: :helper do
+  include Shipyard::BoxHelper
+
+  xit 'should return a default box' do
+    expect(box { 'test' }).to match(%r{<div class="box">test</div>})
+  end
+
+  it 'should return all box types' do
+    %w(secondary padding link).each do |type|
+      expect(box([type.to_sym], 'test')).to match(%r{<div class="box box-#{type}">test</div>})
+    end
+  end
+
+  it 'should return all box sizes' do
+    %w(xxs xs sm md lg xl).each do |size|
+      expect(box([size.to_sym], 'test')).to match(%r{<div class="box box-#{size}">test</div>})
+    end
+  end
+end

data/spec/helpers/button_helper_spec.rb

@@ -0,0 +1,37 @@
+require 'spec_helper'
+
+RSpec.describe Shipyard::ButtonHelper, type: :helper do
+  include Shipyard::ButtonHelper
+
+  it 'should return a default button' do
+    expect(btn('Save')).to match(%r{<button class="btn">Save</button>})
+  end
+
+  it 'should return all other button types' do
+    %w(primary secondary disabled cta caution inverse inverse-secondary).each do |type|
+      expect(btn('Save', type.to_sym)).to match(%r{<button class="btn btn-#{type}">Save</button>})
+    end
+  end
+
+  it 'should return a linked button' do
+    expect(btn('Save', href: '#')).to match(%r{<a href="#" role="button" class="btn">Save</a>})
+  end
+
+  it 'should return a button with a custom data attribute' do
+    expect(btn('Save', data: { btn_type: 'save' })).to match(%r{<button data-btn-type="save" class="btn">Save</button>})
+  end
+
+  it 'should return a button with a custom CSS class' do
+    expect(btn('Save', class: 'shipyard-cta')).to match(%r{<button class="shipyard-cta btn">Save</button>})
+  end
+
+  it 'should return all button sizes' do
+    %w(xxs xs sm md lg xl).each do |size|
+      expect(btn('Save', size.to_sym)).to match(%r{<button class="btn btn-#{size}">Save</button>})
+    end
+  end
+
+  it 'should return a responsive button' do
+    expect(btn('Save', :xs, :x1_md)).to match(%r{<button class="btn btn-xs btn-x1-md">Save</button>})
+  end
+end

data/spec/helpers/form_helper_spec.rb

@@ -0,0 +1,29 @@
+require 'spec_helper'
+
+RSpec.describe Shipyard::FormHelper, type: :helper do
+  include Shipyard::FormHelper
+
+  it 'should return a text box' do
+    expect(input_text(:organization, 'Shipyard')).to(
+      match(%r{<input type="text" name="organization" id="organization" value="Shipyard" class="input input-text" />})
+    )
+  end
+
+  it 'should return a text box with a custom CSS class' do
+    expect(input_text(:organization, 'Shipyard', class: 'shipyard-input')).to(
+      match(%r{<input type="text" name="organization" id="organization" value="Shipyard" class="input input-text shipyard-input" />})
+    )
+  end
+
+  it 'should return a select box' do
+    expect(input_select_tag(:organization, %w(HTML CSS JavaScript))).to(
+      match(%r{<div class="input-select-container"><select name="organization" id="organization" class="input input-select"><option value="HTML">HTML</option>\n<option value="CSS">CSS</option>\n<option value="JavaScript">JavaScript</option></select></div>})
+    )
+  end
+
+  it 'should return a select box wth a custom CSS class' do
+    expect(input_select_tag(:organization, %w(HTML CSS JavaScript), class: 'shipyard-select')).to(
+      match(%r{<div class="input-select-container shipyard-select"><select name="organization" id="organization" class="input input-select"><option value="HTML">HTML</option>\n<option value="CSS">CSS</option>\n<option value="JavaScript">JavaScript</option></select></div>})
+    )
+  end
+end

data/spec/helpers/icon_helper_spec.rb

@@ -0,0 +1,21 @@
+require 'spec_helper'
+
+RSpec.describe Shipyard::IconHelper, type: :helper do
+  include Shipyard::IconHelper
+
+  xit 'should return an svg gear icon with the svg use tag.' do
+    expect(icon(:gear)).to match(/<svg class="icon icon-gear icon-outline"(.+?)><use(.+?)>/)
+  end
+
+  xit 'should return an svg fear icon without the svg use tag.' do
+    expect(icon('gear')).to match(/<svg class="icon icon-gear icon-outline"(.+?)>/)
+  end
+
+  xit 'should return an svg logo icon with a prefixed class name' do
+    expect(icon(:gear, prefix: 'header')).to match(/<svg class="icon icon-gear icon-outline header-icon header-icon-gear" (.+?)><use(.+?)>/)
+  end
+
+  xit 'should return an svg logo icon with a custom CSS class' do
+    expect(icon(:logo, class: 'shipyard-icon')).to match(/<svg class="icon icon-gear icon-outline shipyard-icon" (.+?)><use(.+?)>/)
+  end
+end

data/spec/helpers/note_helper_spec.rb

@@ -0,0 +1,19 @@
+require 'spec_helper'
+
+RSpec.describe Shipyard::NoteHelper, type: :helper do
+  include Shipyard::NoteHelper
+
+  it 'should return a default note' do
+    expect(note nil, 'test').to match(
+      %r{<div class="note">test</div>}
+    )
+  end
+
+  it 'should return all note types' do
+    %w(info success warning error).each do |type|
+      expect(note(type, 'test')).to match(
+        %r{<div class="note note-#{type}">test</div>}
+      )
+    end
+  end
+end

data/spec/shipyard_spec.rb

@@ -1,11 +1,7 @@
-require "spec_helper"
+require 'spec_helper'
 
 describe Shipyard do
-  it "has a version number" do
+  it 'has a version number' do
     expect(Shipyard::VERSION).not_to be nil
   end
-
-  it "does something useful" do
-    expect(false).to eq(true)
-  end
 end

data/spec/spec_helper.rb

@@ -1,2 +1,104 @@
-$LOAD_PATH.unshift File.expand_path("../../lib", __FILE__)
-require "shipyard"
+require 'bundler/setup'
+require 'shipyard-framework'
+Bundler.setup
+
+# 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.
+#
+# 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
+
+  # This option will default to `:apply_to_host_groups` in RSpec 4 (and will
+  # have no way to turn it off -- the option exists only for backwards
+  # compatibility in RSpec 3). It causes shared context metadata to be
+  # inherited by the metadata hash of host groups and examples, rather than
+  # triggering implicit auto-inclusion in groups with matching metadata.
+  config.shared_context_metadata_behavior = :apply_to_host_groups
+
+# The settings below are suggested to provide a good initial experience
+# with RSpec, but feel free to customize to your heart's content.
+=begin
+  # This allows 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. RSpec also provides
+  # aliases for `it`, `describe`, and `context` that include `:focus`
+  # metadata: `fit`, `fdescribe` and `fcontext`, respectively.
+  config.filter_run_when_matching :focus
+
+  # Allows RSpec to persist some state between runs in order to support
+  # the `--only-failures` and `--next-failure` CLI options. We recommend
+  # you configure your source control system to ignore this file.
+  config.example_status_persistence_file_path = "spec/examples.txt"
+
+  # Limits the available syntax to the non-monkey patched syntax that is
+  # recommended. For more details, see:
+  #   - http://rspec.info/blog/2012/06/rspecs-new-expectation-syntax/
+  #   - http://www.teaisaweso.me/blog/2013/05/27/rspecs-new-message-expectation-syntax/
+  #   - http://rspec.info/blog/2014/05/notable-changes-in-rspec-3/#zero-monkey-patching-mode
+  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/styleguide/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: ..
   specs:
-    shipyard-framework (0.5.1)
+    shipyard-framework (0.5.2)
       actionview (~> 5.0)
 
 GEM

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: shipyard-framework
 version: !ruby/object:Gem::Version
-  version: 0.5.1
+  version: 0.5.2
 platform: ruby
 authors:
 - Shipyard
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-09-13 00:00:00.000000000 Z
+date: 2017-09-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: actionview
@@ -31,19 +31,47 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '1.15'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.15'
+- !ruby/object:Gem::Dependency
+  name: sass
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.5'
     - - ">="
       - !ruby/object:Gem::Version
-        version: 1.15.3
+        version: 3.5.1
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.15'
+        version: '3.5'
     - - ">="
       - !ruby/object:Gem::Version
-        version: 1.15.3
+        version: 3.5.1
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.6'
 description: 
 email:
 - ryanwilke@gmail.com
@@ -53,6 +81,7 @@ extra_rdoc_files: []
 files:
 - ".gitignore"
 - ".rspec"
+- ".ruby-version"
 - CODE_OF_CONDUCT.md
 - Gemfile
 - LICENSE.txt
@@ -143,6 +172,12 @@ files:
 - lib/shipyard-framework/rails/railtie.rb
 - lib/shipyard-framework/version.rb
 - shipyard.gemspec
+- spec/helpers/alert_helper_spec.rb
+- spec/helpers/box_helper_spec.rb
+- spec/helpers/button_helper_spec.rb
+- spec/helpers/form_helper_spec.rb
+- spec/helpers/icon_helper_spec.rb
+- spec/helpers/note_helper_spec.rb
 - spec/shipyard_spec.rb
 - spec/spec_helper.rb
 - styleguide/.gitignore
@@ -191,7 +226,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.5.1
+rubygems_version: 2.6.11
 signing_key: 
 specification_version: 4
 summary: A lightweight CSS framework for developing mobile-first projects in Ruby