grand_central-dev_tools 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: d064f30d62199d135226b937cef4b0787b505e78923ce4f599cd0666eb2f2c21
+  data.tar.gz: d093c0b24c760641a110a8470d6157a2b2b9f770e574d99da34b0afc039f1eb6
+SHA512:
+  metadata.gz: 4e5a4f0125d8d055377535b2d401093f1cb6cbbc5d32e0bdfde24ef41ee70077351d110d155ecbe31404d0204bcee198a6a32e3700719d5488b4fdc5568a57af
+  data.tar.gz: 546eec823b0c2290f6b5bcbc8332c12d3bb3bcc804be02848329128c9b6975564727948ce9cf05e330b887d946f68ad023a1bec8a44092962c15cb4b8c2db2b9

data/.gitignore

@@ -0,0 +1,12 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.travis.yml

@@ -0,0 +1,5 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.4.1
+before_install: gem install bundler -v 1.14.6

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at jgaskins@gmail.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [http://contributor-covenant.org/version/1/4][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/4/

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in grand_central-dev_tools.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2017 Jamie Gaskins
+
+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,53 @@
+# GrandCentral::DevTools
+
+Client-side developer tools for the [`grand_central` gem](https://github.com/clearwater-rb/grand_central).
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'grand_central-dev_tools'
+```
+
+And then execute:
+
+    $ bundle
+
+## Usage
+
+Add a div to your HTML document for the dev tools to render into:
+
+```html
+<div id="grand-central"></div>
+```
+
+If you have a `dev.rb` or some other development-only asset, you'll want to add it into there:
+
+```ruby
+# dev.rb
+require 'grand_central/dev_tools'
+require 'store' # Change this to wherever your GrandCentral store is loaded from
+
+dev_tools = GrandCentral::DevTools.new(
+  Store, # Your store object goes here. Any store type will work.
+  Bowser.document['#grand-central'] # The div we added to our HTML document.
+)
+dev_tools.start # Actually begin monitoring the store
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/clearwater-rb/grand_central-dev_tools. 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/Rakefile

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

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "grand_central/dev_tools"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/grand_central-dev_tools.gemspec

@@ -0,0 +1,26 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'grand_central/dev_tools/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "grand_central-dev_tools"
+  spec.version       = GrandCentral::DevTools::VERSION
+  spec.authors       = ["Jamie Gaskins"]
+  spec.email         = ["jgaskins@gmail.com"]
+
+  spec.summary       = %q{Client-side developer tools for GrandCentral}
+  spec.homepage      = "https://github.com/clearwater-rb/grand_central-dev_tools"
+  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_development_dependency "bundler", "~> 1.14"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+end

data/lib/grand_central/dev_tools/version.rb

@@ -0,0 +1,5 @@
+module GrandCentral
+  module DevTools
+    VERSION = "0.1.0"
+  end
+end

data/lib/grand_central/dev_tools.rb

@@ -0,0 +1,5 @@
+require 'grand_central/dev_tools/version'
+require 'clearwater'
+require 'grand_central'
+
+Opal.append_path File.expand_path('../../../opal', __FILE__)

data/opal/grand_central/dev_tools.rb

@@ -0,0 +1,316 @@
+require 'clearwater'
+require 'clearwater/black_box_node'
+
+module GrandCentral
+  class DevTools
+    include Clearwater::Component
+
+    def initialize store, element
+      @store = store
+      @app = Clearwater::Application.new(
+        component: self,
+        element: element,
+      )
+      @initial_state = store.state
+      @dispatches = []
+    end
+
+    def start
+      @app.render
+      @store.on_dispatch do |old, new, action|
+        @dispatches += [Dispatch.new(old, new, action)]
+        @app.render
+      end
+    end
+
+    def render
+      div({
+        style: {
+          font_family: 'monospace',
+          position: :fixed,
+          background: '#555',
+          color: :white,
+          top: 0,
+          right: 0,
+          padding: '1em',
+          box_shadow: '0 0 5px black',
+          overflow: :scroll,
+          box_sizing: 'border-box',
+          max_height: '100vh',
+        },
+      }, [
+        if @open
+          div([
+            div({ style: { text_align: :right } }, [
+              button({ onclick: proc { @open = false; @app.render } }, '-'),
+            ]),
+            h2('State'),
+            ModelPresenter.memoize(@store.state),
+            h2('Actions'),
+            div(@dispatches.map { |dispatch|
+              DispatchPresenter.memoize(
+                dispatch,
+                oncommit: proc {
+                  `#@store.state = #{dispatch.after}`
+                  index = @dispatches.index dispatch
+                  @dispatches = @dispatches[0..index]
+                  call
+                  @app.render
+                },
+                ondelete: proc {
+                  @dispatches = @dispatches.reject { |d| d == dispatch }
+                  new_dispatches = []
+                  new_state = @dispatches.reduce(@initial_state) do |state, d|
+                    s = `#@store.reducer`.call state, d.action
+                    new_dispatches << Dispatch.new(state, s, d.action)
+                    s
+                  end
+                  @dispatches = new_dispatches
+                  `#@store.state = #{new_state}`
+                  call
+                  @app.render
+                }
+              )[dispatch.object_id]
+            }),
+          ])
+        else
+          div({ style: { text_align: :right } }, [
+            span('Grand Central Dev Tools'),
+            button({ onclick: proc { @open = true; @app.render } }, '+'),
+          ])
+        end,
+      ])
+    end
+
+    # Dispatch = Struct.new(:before_state, :after_state, :action)
+    class Dispatch
+      attr_reader :before, :after, :action
+
+      def initialize before, after, action
+        @before = before
+        @action = action
+        @after = after
+      end
+
+      def == other
+        return false unless other.class == self.class
+
+        action == other.action
+      end
+    end
+
+    class Presenter
+      include Clearwater::Component
+
+      attr_reader :model
+      attr_accessor :placeholder
+
+      def self.memoize *args, &block
+        Placeholder.new(self, args, block)
+      end
+
+      def initialize model
+        @model = model
+      end
+
+      def update model
+        @model = model
+      end
+
+      def should_update? model
+        !model.equal? @model
+      end
+
+      def update_self *args
+        args = [@model] if args.empty?
+
+        self.class.memoize(*args).update_self @placeholder, true
+      end
+
+      def serialize_value value
+        case value
+        when String, Numeric, true, false, nil
+          code(value.inspect)
+        when Array 
+          ArrayPresenter.memoize value
+        when Hash
+          HashPresenter.memoize value
+        when Set
+          SetPresenter.memoize value
+        else
+          ModelPresenter.memoize value
+        end
+      end
+
+      def set ivar, value
+        proc do
+          `self[ivar] = value`
+          update_self model
+        end
+      end
+
+      class Placeholder
+        include Clearwater::BlackBoxNode
+
+        attr_reader :klass, :key, :element, :node, :vdom
+
+        def initialize klass, args, block
+          @klass = klass
+          @args = args
+          @block = block
+        end
+
+        def [] key
+          @key = key.to_s
+          self
+        end
+
+        def component
+          @component ||= @klass.new(*@args, &@block)
+        end
+
+        def node
+          @node ||= Clearwater::Component.sanitize_content(component)
+        end
+
+        def mount element
+          @vdom = Clearwater::VirtualDOM::Document.new(element)
+          `#@vdom.tree = #{element.to_n}`
+          `#@vdom.node = #{node}`
+          `#@vdom.rendered = true`
+          @component.placeholder = self
+        end
+
+        def update previous
+          update_self previous
+        end
+
+        def update_self previous, override=false
+          @vdom = previous.vdom
+          @component = previous.component
+
+          if override || component.should_update?(*@args, &@block)
+            component.update(*@args, &@block)
+            @component.placeholder = self
+            @vdom.render component.render
+          end
+        end
+      end
+    end
+
+    class ModelPresenter < Presenter
+      def render
+        attributes = model
+          .instance_variables
+          .map { |ivar| ivar.sub(/^@/, '') }
+          .sort
+          .map { |attr| [attr, `#{model}[#{attr}]`] }
+
+        div({ style: { display: 'inline-block' } }, [
+          h3({ style: { margin: 0 } }, model.class.name),
+          table([
+            tbody(attributes.map { |attr, value|
+              tr({ key: attr, style: { vertical_align: :top } }, [
+                th({ style: { text_align: :right, margin_right: '1em' } }, attr),
+                td(serialize_value value),
+              ])
+            }),
+          ]),
+        ])
+      end
+    end
+
+    class ArrayPresenter < Presenter
+      alias array model
+
+      def render
+        div({ style: { display: 'inline-block' } }, [
+          '[',
+          button({ onclick: set(:show_contents, !@show_contents) }, @show_contents ? '-' : "#{array.count} items"),
+          if @show_contents
+            div({ style: { padding_left: '1em' } }, [
+              array.map { |item| div(serialize_value(item)) },
+            ])
+          end,
+          ']',
+        ])
+      end
+    end
+
+    class HashPresenter < Presenter
+      alias hash model
+
+      def render
+        div([
+          '{',
+          hash.any? ? button({ onclick: set(:show_contents, !@show_contents) }, @show_contents ? '-' : "#{hash.count} key#{'s' unless hash.one?}") : nil,
+          if @show_contents
+            div({ style: { padding_left: '2em' } }, hash.map { |k, v|
+              div([
+                div({ style: { display: 'inline-block', vertical_align: :top } }, serialize_value(k)),
+                ' => ',
+                div({ style: { display: 'inline-block', vertical_align: :top } }, serialize_value(v)),
+              ])
+            })
+          end,
+          '}',
+        ])
+      end
+    end
+
+    class SetPresenter < Presenter
+      def render
+        div({ style: { display: 'inline-block' } }, [
+          'Set[',
+          button({ onclick: set(:show_contents, !@show_contents) }, @show_contents ? '-' : "#{model.count} items"),
+          if @show_contents
+            div({ style: { padding_left: '1em' } }, [
+              model.map { |item| div(serialize_value(item)) },
+            ])
+          end,
+          ']',
+        ])
+      end
+    end
+
+    class DispatchPresenter < Presenter
+      def initialize dispatch, oncommit: proc {}, ondelete: proc {}
+        super dispatch
+        @oncommit = oncommit
+        @ondelete = ondelete
+      end
+
+      def update *args
+        initialize *args
+      end
+
+      def render
+        div([
+          div([
+            button({ onclick: set(:show_contents, !@show_contents) }, @show_contents ? '-' : '+'),
+            button({ onclick: @oncommit }, '!'),
+            button({ onclick: @ondelete }, 'x'),
+            model.action.class.name,
+          ]),
+          if @show_contents
+            dl({ style: { margin: 0 } }, [
+              dt('Action'),
+              dd(ModelPresenter.memoize(model.action)),
+              dt('Before'),
+              dd(ModelPresenter.memoize(model.before)),
+              dt('After'),
+              dd(ModelPresenter.memoize(model.after)),
+            ])
+          end,
+        ])
+      end
+
+      def set ivar, value
+        proc do
+          `self[ivar] = value`
+          update_self model, oncommit: @oncommit, ondelete: @ondelete
+        end
+      end
+    end
+  end
+end

metadata

@@ -0,0 +1,100 @@
+--- !ruby/object:Gem::Specification
+name: grand_central-dev_tools
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Jamie Gaskins
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2017-12-17 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.14'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.14'
+- !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:
+- jgaskins@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- grand_central-dev_tools.gemspec
+- lib/grand_central/dev_tools.rb
+- lib/grand_central/dev_tools/version.rb
+- opal/grand_central/dev_tools.rb
+homepage: https://github.com/clearwater-rb/grand_central-dev_tools
+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.7.2
+signing_key: 
+specification_version: 4
+summary: Client-side developer tools for GrandCentral
+test_files: []