voom-presenters 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: aea3eb243aa5f86d7aa71a53c7d684eb683e647ab9b17af3e32301e2881e8de0
+  data.tar.gz: 84252fbeda896a5932596f7b01d52e0cdd7d2bb65ec2bd2d17626ceb8baa7d64
+SHA512:
+  metadata.gz: 1cadf5dd2065b5a3b373136966d9572909d42cfcfefc3c52e4b3d0a0f6b31ab2dc524548fa998234418e2cb6b1eb61c0322f3073c2227a0462a01668d843131e
+  data.tar.gz: 0ef8a6e7201f2ab172f34179eff871f03152925fc35a49aff307da50f987c4f92bf22b93480224a8c84abc478bb626ade9aa05da4cdd5b08bc755cc0933d5189

data/.gitignore

@@ -0,0 +1,54 @@
+*.gem
+*.rbc
+/.config
+/coverage/
+/InstalledFiles
+/pkg/
+/spec/reports/
+/spec/examples.txt
+/test/tmp/
+/test/version_tmp/
+/tmp/
+
+# Used by dotenv library to load environment variables.
+# .env
+
+## Specific to RubyMotion:
+.dat*
+.repl_history
+build/
+*.bridgesupport
+build-iPhoneOS/
+build-iPhoneSimulator/
+
+## Specific to RubyMotion (use of CocoaPods):
+#
+# We recommend against adding the Pods directory to your .gitignore. However
+# you should judge for yourself, the pros and cons are mentioned at:
+# https://guides.cocoapods.org/using/using-cocoapods.html#should-i-check-the-pods-directory-into-source-control
+#
+# vendor/Pods/
+
+## Documentation cache and generated files:
+/.yardoc/
+/_yardoc/
+/doc/
+/rdoc/
+
+## Environment normalization:
+/.bundle/
+/vendor/bundle
+/lib/bundler/man/
+
+# for a library or gem, you might want to ignore these files since the code is
+# intended to run in multiple environments; otherwise, check them in:
+# Gemfile.lock
+# .ruby-version
+# .ruby-gemset
+
+# unless supporting rvm < 1.11.0 or doing something fancy, ignore this:
+.rvmrc
+
+/.idea/
+.DS_Store
+.env

data/.ruby-version

@@ -0,0 +1 @@
+2.5.0

data/Gemfile

@@ -0,0 +1,11 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in voom-console.gemspec
+gemspec
+
+group :test do
+  gem 'rspec-html-matchers'
+  gem 'watir', '~> 6.10.3'
+  gem "webdrivers", "~> 3.0"
+  gem 'watir-rspec'
+end

data/Gemfile.lock

@@ -0,0 +1,104 @@
+PATH
+  remote: .
+  specs:
+    voom-presenters (0.1.0)
+      dry-configurable (~> 0.7)
+      dry-container (~> 0.6)
+      dry-inflector (~> 0.1)
+      ice_nine (~> 0.11)
+      redcarpet (~> 3.4)
+      sinatra (~> 2.0)
+      tzinfo (~> 1.2)
+      tzinfo-data (~> 1.2018)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    childprocess (0.9.0)
+      ffi (~> 1.0, >= 1.0.11)
+    coderay (1.1.1)
+    concurrent-ruby (1.0.5)
+    diff-lcs (1.2.5)
+    dry-configurable (0.7.0)
+      concurrent-ruby (~> 1.0)
+    dry-container (0.6.0)
+      concurrent-ruby (~> 1.0)
+      dry-configurable (~> 0.1, >= 0.1.3)
+    dry-inflector (0.1.2)
+    ffi (1.9.23)
+    ice_nine (0.11.2)
+    method_source (0.8.2)
+    mini_portile2 (2.3.0)
+    mustermann (1.0.2)
+    nokogiri (1.8.2)
+      mini_portile2 (~> 2.3.0)
+    pry (0.10.4)
+      coderay (~> 1.1.0)
+      method_source (~> 0.8.1)
+      slop (~> 3.4)
+    rack (2.0.4)
+    rack-protection (2.0.1)
+      rack
+    rack-test (0.8.2)
+      rack (>= 1.0, < 3)
+    rake (11.3.0)
+    redcarpet (3.4.0)
+    rspec (3.5.0)
+      rspec-core (~> 3.5.0)
+      rspec-expectations (~> 3.5.0)
+      rspec-mocks (~> 3.5.0)
+    rspec-core (3.5.4)
+      rspec-support (~> 3.5.0)
+    rspec-expectations (3.5.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.5.0)
+    rspec-html-matchers (0.9.1)
+      nokogiri (~> 1)
+      rspec (>= 3.0.0.a, < 4)
+    rspec-mocks (3.5.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.5.0)
+    rspec-support (3.5.0)
+    rubyzip (1.2.1)
+    selenium-webdriver (3.11.0)
+      childprocess (~> 0.5)
+      rubyzip (~> 1.2)
+    sinatra (2.0.1)
+      mustermann (~> 1.0)
+      rack (~> 2.0)
+      rack-protection (= 2.0.1)
+      tilt (~> 2.0)
+    slop (3.6.0)
+    thread_safe (0.3.6)
+    tilt (2.0.8)
+    tzinfo (1.2.5)
+      thread_safe (~> 0.1)
+    tzinfo-data (1.2018.5)
+      tzinfo (>= 1.0.0)
+    watir (6.10.3)
+      selenium-webdriver (~> 3.4, >= 3.4.1)
+    watir-rspec (3.0.0)
+      rspec (~> 3.0)
+      watir (>= 6.0.0.beta4)
+    webdrivers (3.2.4)
+      nokogiri (~> 1.6)
+      rubyzip (~> 1.0)
+      selenium-webdriver (~> 3.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.13)
+  pry (~> 0.10)
+  rack-test (~> 0.8)
+  rake (~> 11.3)
+  rspec (~> 3.0)
+  rspec-html-matchers
+  voom-presenters!
+  watir (~> 6.10.3)
+  watir-rspec
+  webdrivers (~> 3.0)
+
+BUNDLED WITH
+   1.16.1

data/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2018 Russell Edens
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 Russell Edens
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,45 @@
+# Voom::Presenters
+
+A Ruby DSL for describing user interfaces. 
+The semantics are adopted from [Material Design](https://material.io/).
+
+A presenter generates a Presenter Object Model (POM). 
+A POM fully describes a user interface.
+A POM client can fully render user interface from POM.
+
+## Demo
+
+    git clone git@github.com:rx/presenters.git
+    cd presenters/
+    bundle install
+    rackup
+
+    open htt://localhost:9292
+    
+To see the POM:
+
+    open htt://localhost:9292/pom
+  
+
+## User Interface Engine
+
+The POM + A POM Client is an interface engine. 
+
+This example downloads the POM of the index page. 
+Then posts it to the reference web client. 
+That result is then saved to a file and opened up with a browser.
+    
+    curl localhost:9292/pom/index > $TMPDIR/index.json  && curl -d "@$TMPDIR/index.json" -X POST localhost:9292/index > $TMPDIR/index.html && open $TMPDIR/index.html
+    
+## Usage
+
+TODO: Write usage instructions here
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/rx/presenters.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
+

data/ROADMAP.md

@@ -0,0 +1,21 @@
+# Voom::Presenters Roadmap
+
+This is the roadmap for the presenters. It outlines the development direction.
+
+## Components
+  * Tabs
+  * Chips
+  * Linear Progress
+  * Stepper - https://github.com/ahlechandre/mdl-stepper
+  * Table 
+    * Select Events
+    * Paging
+    * Sorting
+    * Filtering
+
+## Other    
+  * Conditional presentation based on client capabilities
+    * For example, use a table on desktop and a list/card on mobile    
+
+## Web-Client
+  * Conversion to MDC for existing MDL components

data/Rakefile

@@ -0,0 +1,6 @@
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+
+task default: :spec

data/app/demo/component_status.pom

@@ -0,0 +1,76 @@
+require 'yaml'
+require_relative 'helpers/indented_grid'
+
+Voom::Presenters.define(:component_status) do
+  helpers Voom::Presenters::Helpers::Inflector
+  helpers Demo::Helpers::IndentedGrid
+
+  attach 'top_nav'
+  attach 'component_drawer'
+  helpers do
+    def status
+      @status ||= YAML::load_file(File.join(__dir__, '../../component-status.yml'))
+    end
+
+    def item_color(item)
+      trace {item.inspect}
+      case item
+        when ->(i) {['low', 'not planned'].include?(i['Priority'])}
+          :lightgray
+        when ->(i) {(i.fetch('Completeness')||0) > 1}
+          :DarkSeaGreen
+        when ->(i) {(i.fetch('Completeness')||0)==1}
+          :LightYellow
+        when ->(i) {['medium', 'high'].include?(i['Priority']) && i['MDC']=='N' && i['MDL']=='N'}
+          :lightcoral
+        when ->(i) {i['Priority']=='medium'}
+          :coral
+        when ->(i) {i['Priority']=='now'}
+          :CornflowerBlue
+        else
+          nil
+      end
+    end
+
+    def key
+      items = [{'Completeness' => 2, text: 'Available'},
+               {'Priority' => 'high', 'Completeness'=>1, 'MDC' => nil, 'MDL' => nil, text: 'Available with caveats'},
+               {'Priority' => 'now', 'Completeness'=>0, 'MDC' => nil, 'MDL' => nil, text: 'In progress'},
+               {'Priority' => 'medium', 'Completeness'=>0, 'MDC' => nil, 'MDL' => nil, text: 'Up Next'},
+                {'Priority' => 'medium', 'Completeness'=>0, 'MDC' => 'N', 'MDL' => 'N', text: 'Implementation needed'},
+               {'Priority' => 'low', 'Completeness'=>0, 'MDC' => 'N', 'MDL' => 'N', text: 'Not Planned'},
+
+              ]
+      table do
+        row do
+          items.each do |item|
+            column color: item_color(item)
+            column item[:text]
+          end
+        end
+      end
+    end
+  end
+
+  indented_grid do
+    display 'Component Status'
+    key
+    table do
+      header do
+        status.first.keys.each do |heading|
+          column inflector.humanize(heading)
+        end
+      end
+
+      status.each do |item|
+        row do
+          status.first.keys.each_with_index do |heading, index|
+            value = item[heading]
+            color = index ==0 ? item_color(item) : nil
+            column value, color: color
+          end
+        end
+      end
+    end
+  end
+end

data/app/demo/components.pom

@@ -0,0 +1,19 @@
+require_relative 'helpers/indented_grid'
+
+Voom::Presenters.define('components') do
+  helpers Demo::Helpers::IndentedGrid
+  attach 'top_nav'
+  attach 'component_drawer'
+
+  indented_grid do
+    display 'Components'
+    grid do
+      column 12 do
+        icon 'fa-hand-point-left', position: :left
+        subheading 'Select a component'
+      end
+    end
+  end
+  attach :code, file: __FILE__
+
+end

data/app/demo/components/badges.pom

@@ -0,0 +1,25 @@
+require_relative '../helpers/indented_grid'
+
+Voom::Presenters.define(:badges) do
+  helpers Demo::Helpers::IndentedGrid
+
+  attach :top_nav
+  attach :component_drawer
+  indented_grid do
+    display 'Badges'
+
+    headline 'Number'
+    badge 1, icon: :account_box
+
+    headline 'Icon'
+    badge '♥', icon: :account_box
+
+    headline 'Number'
+    badge 1, text: 'Inbox'
+
+    headline 'Icon'
+    badge '♥', text: 'Mood'
+
+    attach :code, file: __FILE__
+  end
+end

data/app/demo/components/buttons.pom

@@ -0,0 +1,51 @@
+require_relative '../helpers/indented_grid'
+
+Voom::Presenters.define(:buttons) do
+  helpers Demo::Helpers::IndentedGrid
+  attach :top_nav
+  attach :component_drawer
+
+  indented_grid do
+    display 'Buttons'
+    
+    # Raised buttons
+    headline 'Raised Button'
+    button 'Button', type: :raised
+
+    subheading 'Disabled'
+    button 'Button', type: :raised, disabled: true
+
+    subheading ' Accent colored'
+    button 'Button', type: :raised, color: :secondary
+
+    headline 'Flat button'
+    button 'Button'
+
+    subheading 'Disabled'
+    button 'Button', type: :flat, disabled: true
+
+    subheading 'Accent colored flat'
+    button 'Button', type: :flat, color: :secondary
+
+    subheading 'Aligned'
+    grid do
+      column 3 do
+        button 'Not Aligned'
+        button 'Right', position: :right
+        button 'Left', position: :left
+      end
+    end
+
+    # Icon Buttons
+    headline 'Icon button'
+    button icon: :mood
+    subheading 'Colored'
+    button icon: :mood, color: :primary
+    button icon: :mood, color: :secondary
+
+    subheading 'with text'
+    button "I'm happy", icon: :mood
+
+    attach :code, file: __FILE__
+  end
+end