shipyard-framework 0.2.2

data/assets/stylesheets/shipyard/variables/_colors.scss

@@ -0,0 +1,11 @@
+$colors: (
+  gray: (base: #788594, light: #bac5d2, lighter: #dfe6eb, lightest: #f2f5f7, dark: #313a44, darkest: #1e252c),
+  green: (base: #3acc7c, light: #97ffc6, lightest: #b5ffd6, dark: #2c995d, darkest: #1d663e),
+  blue: (base: #1ca1e3, light: #5eb9e6, lightest: #9ed8f5, dark: #0075b0, darkest: #004d73),
+  teal: (base: #20a5a8, light: #6ab7b9, lightest: #b2dbdc, dark: #0e6e70, darkest: #00494b),
+  red: (base: #e06158, light: #f7a09e, lightest: #ffc6cb, dark: #b13b39, darkest: #892120),
+  yellow: (base: #ffca49, light: #ffd87e, lightest: #ffe7b1, dark: #99782d, darker: #66501e, darkest: #33280f),
+  orange: (base: #ff9f49, light: #ffba7d, lightest: #ffd6b1, dark: #cc7f3a, darkest: #995f2c),
+  purple: (base: #bf84ff, light: lighten(#bf84ff, 10%), lighter: lighten(#bf84ff, 15%), lightest: lighten(#bf84ff, 20%), dark: darken(#bf84ff, 10%), darker: darken(#bf84ff, 15%), darkest: darken(#bf84ff, 20%)),
+  coral: (base: #f9657a, light: lighten(#f9657a, 10%), lighter: lighten(#f9657a, 15%), lightest: lighten(#f9657a, 20%), dark: darken(#f9657a, 10%), darker: darken(#f9657a, 15%), darkest: darken(#f9657a, 20%))
+);

data/assets/stylesheets/shipyard/variables/_grid.scss

@@ -0,0 +1,2 @@
+$breakpoints: (x1: 770px, x2: 920px, x3: 1200px, x4: 1600px);
+$margins: (x0: 10px, x1: 20px, x2: 30px, x3: 30px, x4: 40px);

data/assets/stylesheets/shipyard/variables/_misc.scss

@@ -0,0 +1,11 @@
+$bg-color: $gray-lightest;
+
+$border-radius: 5px;
+
+$border-color: darken($bg-color, 12%);
+$border-color-dark: darken($border-color, 10%);
+$border-color-darker: darken($border-color, 14%);
+$border-color-darkest: darken($border-color, 18%);
+$border-color-light: darken($bg-color, 6%);
+$border-color-lighter: darken($bg-color, 4%);
+$border-color-lightest: darken($bg-color, 2%);

data/assets/stylesheets/shipyard/variables/_typography.scss

@@ -0,0 +1,29 @@
+// Font
+$font-family: 'museo-sans-rounded', 'Museo Sans Rounded', Arial, sans-serif;
+
+// Font: Weights
+$normal: 300;
+$italic: 400;
+$medium: 500;
+$medium-italic: 600;
+$bold: 700;
+$bold-italic: 800;
+
+$font-sizes: (xxs: 12px, xs: 13px, sm: 14px, md: 16px, lg: 18px, xl: 20px, xxl: 22px, xxxl: 24px);
+$font-size: map-get($font-sizes, md);
+$font-size-xxxl: map-get($font-sizes, xxxl);
+$font-size-xxl: map-get($font-sizes, xxl);
+$font-size-xl: map-get($font-sizes, xl);
+$font-size-lg: map-get($font-sizes, lg);
+$font-size-sm: map-get($font-sizes, sm);
+$font-size-xs: map-get($font-sizes, xs);
+$font-size-xxs: map-get($font-sizes, xxs);
+$font: $normal 16px / 1.6 $font-family;
+$text-color: $gray-dark;
+$text-color-disabled: lighten($gray, 15%);
+$text-color-lightest: lighten($gray, 10%);
+$text-color-lighter: lighten($gray, 5%);
+$text-color-light: $gray;
+$text-color-darkest: $gray-dark;
+$text-color-darker: lighten($gray-dark, 4%);
+$text-color-dark: lighten($gray-dark, 7%);

data/lib/shipyard/icons.rb

@@ -0,0 +1,89 @@
+module Shipyard
+  class Icons
+    include ActionView::Helpers::SanitizeHelper
+    include Singleton
+    attr_reader :icons
+    delegate :each, :find, to: :icons
+    delegate :execute_if_updated, :execute, :updated?, to: :updater
+
+    def initialize
+      @path = "#{::Rails.root}/app/assets/icons/"
+      @public = "#{::Rails.root}/public/assets"
+      reload
+    end
+
+    def reload
+      @icons = load_svgs.freeze
+      save_external_svg_defs
+    end
+
+    def find_by(hash)
+      icon = @icons.detect { |i| i[hash.keys.first] == hash.values.first }
+      raise_error(hash.values.first) unless icon
+      icon
+    end
+
+    private
+
+    def load_svgs
+      files.sort.map do |file|
+        html = File.read(file)
+        {
+          file: file,
+          path: file.gsub(@path, ''),
+          id: File.basename(file).gsub(/.svg/, ''),
+          symbol: File.basename(file).gsub(/.svg/, '').underscore.to_sym,
+          view_box: html[/viewBox="(.*?)"/, 1],
+          outer_html: html.gsub(/\n|\s+\s+/, ''),
+          inner_html: sanitize_svg(html).gsub(/\n|\s+\s+/, ''),
+          is_outlined: html.include?('non-scaling-stroke')
+        }
+      end
+    end
+
+    def save_external_svg_defs
+      html = []
+      @icons.each do |icon|
+        html << svg_group(icon)
+      end
+      Dir.mkdir(@public) unless File.exists?(@public) || Dir.exists?(@public)
+      File.write("#{@public}/icons.svg", svg_template(html.join))
+    end
+
+    def sanitize_svg(html)
+      sanitize(html,
+               tags: %w(g circle rect path line polyline),
+               attributes: %w(x x1 x2 y y1 y2 d cx cy r vector-effect points class))
+    end
+
+    def svg_group(icon)
+      %(<g id="#{icon[:id]}">#{icon[:inner_html]}</g>)
+    end
+
+    def svg_template(html)
+      %(
+        <?xml version="1.0" standalone="no"?>
+        <!DOCTYPE svg PUBLIC "-//W3C//DTD SVG 1.1//EN" "http://www.w3.org/Graphics/SVG/1.1/DTD/svg11.dtd">
+        <svg xmlns="http://www.w3.org/2000/svg" version="1.1">
+          <defs>#{html}</defs>
+        </svg>
+      ).gsub(/\n|\s+\s+/, '')
+    end
+
+    def files
+      files = Dir[Pathname(Shipyard.icons_path).join('**/*.svg')]
+      files.concat Dir[Pathname(@path).join('**/*.svg')]
+    end
+
+    def raise_error(name)
+      return unless ::Rails.env.development? || ::Rails.env.test?
+      raise "Missing icon #{name}"
+    end
+
+    def updater
+      @updater ||= ActiveSupport::FileUpdateChecker.new([], @path => [:svg]) do
+        reload
+      end
+    end
+  end
+end

data/lib/shipyard/rails/alert_helper.rb

@@ -0,0 +1,45 @@
+module Shipyard
+  module Rails
+    module AlertHelper
+      def flash_alert(*args, &block)
+        alert_txt = capture(&block) if block_given?
+        options = {}
+        options[:role] ||= 'alert'
+        options[:data] ||= {}
+        options[:data][:shipyard] = 'alert'
+        options['v-show'] = 'visible'
+        class_list = ['alert']
+
+        args.each do |arg|
+          if arg.is_a? Symbol
+            class_list << "alert-#{alert_type(arg)}"
+          elsif arg.is_a? Hash
+            options = options.merge(arg) if arg.is_a?(Hash)
+          else
+            alert_txt = arg
+          end
+        end
+
+        options[:class] = "#{class_list.join(' ')} #{options[:class]}"
+
+        content_tag :div, options do
+          concat content_tag(:p, raw(alert_txt), class: 'alert-txt')
+          concat content_tag(:button,
+                             icon('x', class: 'alert-close-icon icon-outline-inverse center'),
+                             class: 'alert-close v-center',
+                             '@click': 'close')
+        end
+      end
+
+      private
+
+      def alert_type(type)
+        case type.to_sym
+        when :notice then :success
+        when :alert then :error
+        else type.to_s.tr('_', '-')
+        end
+      end
+    end
+  end
+end

data/lib/shipyard/rails/button_helper.rb

@@ -0,0 +1,37 @@
+module Shipyard
+  module Rails
+    module ButtonHelper
+      def btn(name, *args, &block)
+        if block_given?
+          args << name
+          name = capture(&block)
+        end
+
+        # Save any options that were passed in.
+        options = {}
+        args.each do |arg|
+          options = options.merge(arg) if arg.is_a?(Hash)
+        end
+
+        # Output the appropriate button.
+        if options.key?(:href)
+          link_to name, options[:href], btn_options(args, options)
+        else
+          content_tag :button, name, btn_options(args, options)
+        end
+      end
+
+      private
+
+      def btn_options(args, options)
+        options[:class] ||= ''
+        options[:class] += ' btn'
+        args.each do |arg|
+          options[:class] += " btn-#{arg.to_s.tr('_', '-')}" if arg.is_a?(Symbol)
+        end
+        options[:class].strip!
+        options.except(:href)
+      end
+    end
+  end
+end

data/lib/shipyard/rails/engine.rb

@@ -0,0 +1,11 @@
+module Shipyard
+  module Rails
+    class Engine < ::Rails::Engine
+      initializer 'shipyard.assets.precompile', group: :all do |app|
+        %w(stylesheets javascripts).each do |sub|
+          app.config.assets.paths << root.join('assets', sub).to_s
+        end
+      end
+    end
+  end
+end

data/lib/shipyard/rails/icon_helper.rb

@@ -0,0 +1,50 @@
+module Shipyard
+  module Rails
+    module IconHelper
+      include ActionView::Context
+      include ActionView::Helpers::TagHelper
+
+      def icon(name, options={})
+        if name.is_a? Symbol
+          svg = Icons.instance.find_by(symbol: name)
+          svg_use_tag svg, options
+        else
+          svg = Icons.instance.find_by(id: name)
+          svg_tag svg, options
+        end
+      end
+
+      private
+
+      def svg_options(svg, options)
+        options[:class] = svg_classes(svg, options)
+        options[:viewBox] ||= svg[:view_box]
+        options[:preserveAspectRatio] ||= 'xMinYMin meet'
+        options.delete(:prefix)
+        options
+      end
+
+      def svg_classes(svg, options)
+        css_classes = []
+        css_classes << 'icon'
+        css_classes << "icon-#{svg[:id]}"
+        css_classes << 'icon-outline' if svg[:is_outlined] == true
+        css_classes << "#{options[:prefix]}-icon-#{svg[:id]}" if options[:prefix]
+        css_classes << options[:class]
+        css_classes.join(' ').strip
+      end
+
+      def svg_use_tag(svg, options)
+        content_tag :svg, svg_options(svg, options) do
+          content_tag :use, nil, 'xlink:href' => "/assets/icons.svg##{svg[:id]}"
+        end
+      end
+
+      def svg_tag(svg, options)
+        html = svg[:inner_html]
+        html = html.gsub(/class="([\s\w-]+)"/, "class=\"#{options[:prefix]}-\\1 \\1\"") if options[:prefix]
+        content_tag :svg, raw(html), svg_options(svg, options)
+      end
+    end
+  end
+end

data/lib/shipyard/rails/layout_helpers.rb

@@ -0,0 +1,34 @@
+module Shipyard
+  module Rails
+    module LayoutHelpers
+      def layout_classes(layout_name)
+        "#{layout_name}-layout #{current_page} #{'legacy-content' unless content_for? :new_layout}"
+      end
+
+      def current_page
+        "#{controller.controller_name.dasherize}-#{controller.action_name}"
+      end
+
+      def current_route
+        "#{controller.controller_name}##{controller.action_name}"
+      end
+
+      def current_route_is?(routes)
+        routes.tr(' ', '').split(',').include? current_route
+      end
+
+      def content(options={}, &block)
+        type, options = options, {} if options.is_a? Symbol
+        options[:class] ||= ''
+        options[:class] +=  type ? " content-#{type.to_s.dasherize}" : ' content'
+        options[:class] +=  " #{current_page}-content"
+        options[:data] ||= {}
+        options[:data][:content] = current_page
+        content_tag :div, options do
+          concat render(partial: 'shipyard/alerts')
+          concat capture(&block)
+        end
+      end
+    end
+  end
+end

data/lib/shipyard/rails/railtie.rb

@@ -0,0 +1,24 @@
+require 'shipyard/rails/layout_helpers'
+require 'shipyard/rails/icon_helper'
+require 'shipyard/rails/button_helper'
+require 'shipyard/rails/alert_helper'
+
+module Shipyard
+  module Rails
+    class Railtie < ::Rails::Railtie
+      initializer 'shipyard.view_helpers' do
+        ActionView::Base.send :include, LayoutHelpers
+        ActionView::Base.send :include, IconHelper
+        ActionView::Base.send :include, ButtonHelper
+        ActionView::Base.send :include, AlertHelper
+      end
+
+      initializer 'shipyard.reload_cached_icons' do
+        if ::Rails.env.development?
+          ::Rails.application.reloaders << Shipyard::Icons.instance
+          ::Rails.application.config.to_prepare { Shipyard::Icons.instance.execute_if_updated }
+        end
+      end
+    end
+  end
+end

data/lib/shipyard/version.rb

@@ -0,0 +1,3 @@
+module Shipyard
+  VERSION = '0.2.2'
+end

data/lib/shipyard.rb

@@ -0,0 +1,65 @@
+require 'shipyard/version'
+
+module Shipyard
+  class << self
+    def load!
+      if rails?
+        register_rails_engine
+      elsif sprockets?
+        register_sprockets
+      end
+
+      configure_sass
+    end
+
+    # Paths
+    def gem_path
+      @gem_path ||= File.expand_path '..', File.dirname(__FILE__)
+    end
+
+    def stylesheets_path
+      File.join assets_path, 'stylesheets'
+    end
+
+    def javascripts_path
+      File.join assets_path, 'javascripts'
+    end
+
+    def icons_path
+      File.join assets_path, 'icons'
+    end
+
+    def assets_path
+      @assets_path ||= File.join gem_path, 'assets'
+    end
+
+    private
+
+    def sprockets?
+      defined?(::Sprockets)
+    end
+
+    def rails?
+      defined?(::Rails)
+    end
+
+    def configure_sass
+      require 'sass'
+
+      ::Sass.load_paths << stylesheets_path
+    end
+
+    def register_rails_engine
+      require 'shipyard/icons'
+      require 'shipyard/rails/engine'
+      require 'shipyard/rails/railtie'
+    end
+
+    def register_sprockets
+      Sprockets.append_path(stylesheets_path)
+      Sprockets.append_path(javascripts_path)
+    end
+  end
+end
+
+Shipyard.load!

data/shipyard.gemspec

@@ -0,0 +1,27 @@
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'shipyard/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'shipyard-framework'
+  spec.version       = Shipyard::VERSION
+  spec.authors       = ['Shipyard']
+  spec.email         = ['ryanwilke@gmail.com']
+  spec.summary       = 'A lightweight CSS framework for developing mobile-first projects in Ruby on Rails.'
+  spec.homepage      = 'https://github.com/shipyard-framework'
+  spec.license       = 'MIT'
+
+  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_runtime_dependency 'sassc-rails', '~> 1.3', '>= 1.3.0'
+  spec.add_runtime_dependency 'slim-rails', '~> 3.1', '>= 3.1.0'
+
+  spec.add_development_dependency 'bundler', '~> 1.13'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'rspec', '~> 3.0'
+end

metadata

@@ -0,0 +1,181 @@
+--- !ruby/object:Gem::Specification
+name: shipyard-framework
+version: !ruby/object:Gem::Version
+  version: 0.2.2
+platform: ruby
+authors:
+- Shipyard
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2017-07-27 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: sassc-rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.3.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.3.0
+- !ruby/object:Gem::Dependency
+  name: slim-rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.1'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.1.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.1'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.1.0
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.13'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.13'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+description: 
+email:
+- ryanwilke@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- app/views/shipyard/_alerts.slim
+- assets/icons/arrows/arrow-down.svg
+- assets/icons/gear.svg
+- assets/icons/plus.svg
+- assets/icons/x.svg
+- assets/javascripts/shipyard.es6
+- assets/javascripts/shipyard/alert.es6
+- assets/javascripts/shipyard/core.es6
+- assets/javascripts/shipyard/icon.es6
+- assets/stylesheets/_shipyard.sass
+- assets/stylesheets/shipyard/_components.sass
+- assets/stylesheets/shipyard/_core.sass
+- assets/stylesheets/shipyard/_utilities.sass
+- assets/stylesheets/shipyard/components/_alerts.sass
+- assets/stylesheets/shipyard/components/_boxes.sass
+- assets/stylesheets/shipyard/components/_buttons.sass
+- assets/stylesheets/shipyard/components/_empty.sass
+- assets/stylesheets/shipyard/components/_forms.sass
+- assets/stylesheets/shipyard/components/_icons.sass
+- assets/stylesheets/shipyard/components/_modals.sass
+- assets/stylesheets/shipyard/functions/_color.sass
+- assets/stylesheets/shipyard/mixins/_box-model.sass
+- assets/stylesheets/shipyard/mixins/_components.sass
+- assets/stylesheets/shipyard/mixins/_positioning.sass
+- assets/stylesheets/shipyard/mixins/_prefixed.sass
+- assets/stylesheets/shipyard/mixins/_responsive.sass
+- assets/stylesheets/shipyard/mixins/_selectors.sass
+- assets/stylesheets/shipyard/utilities/_animations.sass
+- assets/stylesheets/shipyard/utilities/_grid.sass
+- assets/stylesheets/shipyard/utilities/_positioning.sass
+- assets/stylesheets/shipyard/utilities/_reset.sass
+- assets/stylesheets/shipyard/utilities/_type.sass
+- assets/stylesheets/shipyard/variables/_color_utilities.sass
+- assets/stylesheets/shipyard/variables/_colors.scss
+- assets/stylesheets/shipyard/variables/_grid.scss
+- assets/stylesheets/shipyard/variables/_misc.scss
+- assets/stylesheets/shipyard/variables/_typography.scss
+- lib/shipyard.rb
+- lib/shipyard/icons.rb
+- lib/shipyard/rails/alert_helper.rb
+- lib/shipyard/rails/button_helper.rb
+- lib/shipyard/rails/engine.rb
+- lib/shipyard/rails/icon_helper.rb
+- lib/shipyard/rails/layout_helpers.rb
+- lib/shipyard/rails/railtie.rb
+- lib/shipyard/version.rb
+- shipyard.gemspec
+homepage: https://github.com/shipyard-framework
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.5.1
+signing_key: 
+specification_version: 4
+summary: A lightweight CSS framework for developing mobile-first projects in Ruby
+  on Rails.
+test_files: []