hyper-console 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 771a51bc72df0a15f6a12898b8aaee315266301c
+  data.tar.gz: 9ef9b3bb8ce2447c24e6285ac236768097fe4fdb
+SHA512:
+  metadata.gz: 557f5e0621c254ca74227520900d1aaf64f059d3889a41521c113ffec0bb2f4026b99ef1d1db9454a2b1abb64c2c79157d16bd2bb3c3f1785ece6e7001d95b0e
+  data.tar.gz: d2331e57ec5830baefc19ae6dee3b8f34e7935638d908b545c35add669e5dd8ed7c2281f45add9d69ba3fd134bd2b3f597ce862dd104256eac3367ad3015acdf

data/.gitignore

@@ -0,0 +1,49 @@
+*.rbc
+capybara-*.html
+.rspec
+/log
+/tmp
+/db/*.sqlite3
+/db/*.sqlite3-journal
+/public/system
+/coverage/
+/spec/tmp
+**.orig
+rerun.txt
+pickle-email-*.html
+
+# TODO Comment out these rules if you are OK with secrets being uploaded to the repo
+config/initializers/secret_token.rb
+config/secrets.yml
+
+# dotenv
+# TODO Comment out this rule if environment variables can be committed
+.env
+
+## Environment normalization:
+/.bundle
+/vendor/bundle
+
+# these should all be checked in to normalize the environment:
+# Gemfile.lock, .ruby-version, .ruby-gemset
+
+# unless supporting rvm < 1.11.0 or doing something fancy, ignore this:
+.rvmrc
+
+# if using bower-rails ignore default bower_components path bower.json files
+/vendor/assets/bower_components
+*.bowerrc
+bower.json
+
+# Ignore pow environment settings
+.powenv
+
+# Ignore Byebug command history file.
+.byebug_history
+
+# Ignore test app files
+/spec/test_app/log/
+/spec/test_app/tmp/
+
+# Ignore built gem
+*.gem

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,49 @@
+# Contributor Code of Conduct
+
+As contributors and maintainers of this project, and in the interest of
+fostering an open and welcoming community, we pledge to respect all people who
+contribute through reporting issues, posting feature requests, updating
+documentation, submitting pull requests or patches, and other activities.
+
+We are committed to making participation in this project a harassment-free
+experience for everyone, regardless of level of experience, gender, gender
+identity and expression, sexual orientation, disability, personal appearance,
+body size, race, ethnicity, age, religion, or nationality.
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery
+* Personal attacks
+* Trolling or insulting/derogatory comments
+* Public or private harassment
+* Publishing other's private information, such as physical or electronic
+  addresses, without explicit permission
+* Other unethical or unprofessional conduct
+
+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.
+
+By adopting this Code of Conduct, project maintainers commit themselves to
+fairly and consistently applying these principles to every aspect of managing
+this project. Project maintainers who do not follow or enforce the Code of
+Conduct may be permanently removed from the project team.
+
+This code of conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community.
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting a project maintainer at mitch@catprint.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. Maintainers are
+obligated to maintain confidentiality with regard to the reporter of an
+incident.
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage],
+version 1.3.0, available at
+[http://contributor-covenant.org/version/1/3/0/][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/3/0/

data/Gemfile

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

data/Gemfile.lock

@@ -0,0 +1,235 @@
+PATH
+  remote: .
+  specs:
+    hyper-console (0.1.0)
+      hyper-operation
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    actioncable (5.0.2)
+      actionpack (= 5.0.2)
+      nio4r (>= 1.2, < 3.0)
+      websocket-driver (~> 0.6.1)
+    actionmailer (5.0.2)
+      actionpack (= 5.0.2)
+      actionview (= 5.0.2)
+      activejob (= 5.0.2)
+      mail (~> 2.5, >= 2.5.4)
+      rails-dom-testing (~> 2.0)
+    actionpack (5.0.2)
+      actionview (= 5.0.2)
+      activesupport (= 5.0.2)
+      rack (~> 2.0)
+      rack-test (~> 0.6.3)
+      rails-dom-testing (~> 2.0)
+      rails-html-sanitizer (~> 1.0, >= 1.0.2)
+    actionview (5.0.2)
+      activesupport (= 5.0.2)
+      builder (~> 3.1)
+      erubis (~> 2.7.0)
+      rails-dom-testing (~> 2.0)
+      rails-html-sanitizer (~> 1.0, >= 1.0.3)
+    activejob (5.0.2)
+      activesupport (= 5.0.2)
+      globalid (>= 0.3.6)
+    activemodel (5.0.2)
+      activesupport (= 5.0.2)
+    activerecord (5.0.2)
+      activemodel (= 5.0.2)
+      activesupport (= 5.0.2)
+      arel (~> 7.0)
+    activesupport (5.0.2)
+      concurrent-ruby (~> 1.0, >= 1.0.2)
+      i18n (~> 0.7)
+      minitest (~> 5.1)
+      tzinfo (~> 1.1)
+    addressable (2.5.1)
+      public_suffix (~> 2.0, >= 2.0.2)
+    arel (7.1.4)
+    babel-source (5.8.35)
+    babel-transpiler (0.7.0)
+      babel-source (>= 4.0, < 6)
+      execjs (~> 2.0)
+    builder (3.2.3)
+    coffee-script-source (1.12.2)
+    concurrent-ruby (1.0.5)
+    connection_pool (2.2.1)
+    cookiejar (0.3.3)
+    daemons (1.2.4)
+    em-http-request (1.1.5)
+      addressable (>= 2.3.4)
+      cookiejar (!= 0.3.1)
+      em-socksify (>= 0.3)
+      eventmachine (>= 1.0.3)
+      http_parser.rb (>= 0.6.0)
+    em-socksify (0.3.1)
+      eventmachine (>= 1.0.0.beta.4)
+    em-websocket (0.5.1)
+      eventmachine (>= 0.12.9)
+      http_parser.rb (~> 0.6.0)
+    erubis (2.7.0)
+    eventmachine (1.2.3)
+    execjs (2.7.0)
+    globalid (0.4.0)
+      activesupport (>= 4.2.0)
+    hike (1.2.3)
+    http_parser.rb (0.6.0)
+    httpclient (2.8.3)
+    hyper-component (0.12.3)
+      hyper-react (>= 0.12.3)
+      hyperloop-config (>= 0.9.2)
+      opal-rails (~> 0.9.0)
+      react-rails (< 1.10.0)
+    hyper-operation (0.5.4)
+      activerecord (>= 0.3.0)
+      hyper-component (>= 0.12.2)
+      hyperloop-config (>= 0.9.7)
+      mutations
+      opal-activesupport
+      pusher
+      pusher-fake
+    hyper-react (0.12.5)
+      hyper-store (>= 0.2.1)
+      hyperloop-config (>= 0.9.7)
+      opal (>= 0.8.0)
+      opal-activesupport (>= 0.2.0)
+    hyper-store (0.2.2)
+      hyperloop-config (>= 0.9.2)
+    hyperloop-config (0.9.8)
+      opal
+      opal-browser
+    i18n (0.8.1)
+    jquery-rails (4.3.1)
+      rails-dom-testing (>= 1, < 3)
+      railties (>= 4.2.0)
+      thor (>= 0.14, < 2.0)
+    loofah (2.0.3)
+      nokogiri (>= 1.5.9)
+    mail (2.6.4)
+      mime-types (>= 1.16, < 4)
+    method_source (0.8.2)
+    mime-types (3.1)
+      mime-types-data (~> 3.2015)
+    mime-types-data (3.2016.0521)
+    mini_portile2 (2.1.0)
+    minitest (5.10.1)
+    multi_json (1.12.1)
+    mutations (0.8.1)
+      activesupport
+    nio4r (2.0.0)
+    nokogiri (1.7.1)
+      mini_portile2 (~> 2.1.0)
+    opal (0.10.3)
+      hike (~> 1.2)
+      sourcemap (~> 0.1.0)
+      sprockets (~> 3.1)
+      tilt (>= 1.4)
+    opal-activesupport (0.3.0)
+      opal (>= 0.5.0, < 1.0.0)
+    opal-browser (0.2.0)
+      opal
+      paggio
+    opal-jquery (0.4.2)
+      opal (>= 0.7.0, < 0.11.0)
+    opal-rails (0.9.1)
+      jquery-rails
+      opal (>= 0.8.0, < 0.11)
+      opal-activesupport (>= 0.0.5)
+      opal-jquery (~> 0.4.0)
+      opal-sprockets (~> 0.4.0)
+      rails (>= 4.0, < 6.0)
+      sprockets-rails (< 3.0)
+    opal-sprockets (0.4.0.0.10.0.3.0.0)
+      opal (~> 0.10.0)
+      sprockets (~> 3.0)
+      tilt (>= 1.4)
+    paggio (0.2.6)
+    public_suffix (2.0.5)
+    pusher (1.3.1)
+      httpclient (~> 2.7)
+      multi_json (~> 1.0)
+      pusher-signature (~> 0.1.8)
+    pusher-fake (1.8.0)
+      em-http-request (~> 1.1)
+      em-websocket (~> 0.5)
+      multi_json (~> 1.6)
+      thin (~> 1.5)
+    pusher-signature (0.1.8)
+    rack (2.0.1)
+    rack-test (0.6.3)
+      rack (>= 1.0)
+    rails (5.0.2)
+      actioncable (= 5.0.2)
+      actionmailer (= 5.0.2)
+      actionpack (= 5.0.2)
+      actionview (= 5.0.2)
+      activejob (= 5.0.2)
+      activemodel (= 5.0.2)
+      activerecord (= 5.0.2)
+      activesupport (= 5.0.2)
+      bundler (>= 1.3.0, < 2.0)
+      railties (= 5.0.2)
+      sprockets-rails (>= 2.0.0)
+    rails-dom-testing (2.0.2)
+      activesupport (>= 4.2.0, < 6.0)
+      nokogiri (~> 1.6)
+    rails-html-sanitizer (1.0.3)
+      loofah (~> 2.0)
+    railties (5.0.2)
+      actionpack (= 5.0.2)
+      activesupport (= 5.0.2)
+      method_source
+      rake (>= 0.8.7)
+      thor (>= 0.18.1, < 2.0)
+    rake (10.5.0)
+    react-rails (1.9.0)
+      babel-transpiler (>= 0.7.0)
+      coffee-script-source (~> 1.8)
+      connection_pool
+      execjs
+      railties (>= 3.2)
+      tilt
+    sourcemap (0.1.1)
+    sprockets (3.7.1)
+      concurrent-ruby (~> 1.0)
+      rack (> 1, < 3)
+    sprockets-rails (2.3.3)
+      actionpack (>= 3.0)
+      activesupport (>= 3.0)
+      sprockets (>= 2.8, < 4.0)
+    thin (1.7.0)
+      daemons (~> 1.0, >= 1.0.9)
+      eventmachine (~> 1.0, >= 1.0.4)
+      rack (>= 1, < 3)
+    thor (0.19.4)
+    thread_safe (0.3.6)
+    tilt (2.0.7)
+    tzinfo (1.2.3)
+      thread_safe (~> 0.1)
+    uglifier (3.2.0)
+      execjs (>= 0.3.0, < 3)
+    websocket-driver (0.6.5)
+      websocket-extensions (>= 0.1.0)
+    websocket-extensions (0.1.2)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.12)
+  hyper-component
+  hyper-console!
+  hyper-operation
+  hyper-store
+  hyperloop-config
+  opal
+  opal-browser
+  opal-jquery
+  opal-rails (>= 0.8.1)
+  rails
+  rake (~> 10.0)
+  uglifier
+
+BUNDLED WITH
+   1.12.5

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2017 catmando
+
+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,135 @@
+# Hyper-Console
+
+IRB style console for [Hyperloop](http://ruby-hyperloop.io) applications.
+
+![Screen](screen_shot.png)
+
+### Installation
+
+Add
+
+```ruby
+gem 'hyper-console'
+```
+
+To the development and test sections of your Gemfile.
+
+Do a `bundle install`, and `rm -rf tmp/cache`, then restart the server, hit one of your web pages, and the console will open.
+
+*Note currently you must have enabled the `Hyperloop::Application` channel in your policies.  Hopefully we can remove this in the future*
+
+*Note for Rails 4.x you will also need to add these lines to `config/initializer/assets.rb`:*
+
+```ruby
+Rails.application.config.assets.precompile += %w( hyper-console-client.css )
+Rails.application.config.assets.precompile += %w( hyper-console-client.min.js )
+```
+
+### Details
+
+The `hyper-console` gem adds the `console` method to `Kernel`.  If you call `console` from anywhere in your client code, it will open a new *popup* window, that is running an IRB style read-eval loop.  The console window will compile what ever ruby code you type, and if it compiles, will send it to your main window for execution.  The result (or error message) plus any console output will be displayed in the console window.
+
++ You may use the up/down arrow keys to move to previous expressions, edit them, and resend.  
++ If you are editing a block of code you can send the block immediately without moving to the end of the expression by using command (or ctrl) enter.
++ The console history is stored in the popups html local store, so it will be retained across window reloads.
++ The expression can be arbitrarily complex.  You can investigate model scopes, and attributes, run Operations, and get the current value of component states.
++ You can even create classes, or open existing classes and modify their behavior.
+
+### The `instance` method
+
+The console gem adds an `instance` method to all classes.  This will return an array like object of all the current instances of that class, *except instances bound to closures (sorry!)*.  
+
+For example if you have a component named `Components::TodoItem` then
+
+```ruby
+Components::TodoItem.instance[0] # first instance
+Components::TodoItem.instance    # array of all the instances
+Components::TodoItem.instance[0].dom_node  # returns the mount point
+```
+
+This is all very handy for investigating the state of Components and Stores.  For example assuming your top level component is named `App` and is using hyper-router, you can do things like this:
+
+```ruby
+App.instance[0].location.pathname # current path
+App.instance[0].history.push '/topics' # change path to `/topics`
+```
+
+Because its common for there to be a single instance of some classes, the expression `instance[0]` can be shortened to just `instance` when there is only one instance of a class.  For example in the above example you could just say `App.instance.location.pathname`.
+
+### Console Context
+
+Each console window (you can have several) has an execution context, which is simply an expression that is used to determine the value of `self` that console executes in.  
+
+For example let's say you have a `Todo` model.  You could in the console window evaluate
+
+```ruby
+console context: 'Todo.first'
+```
+
+And a new console window will be opened that is "bound" to `Todo.first` so that in this window you can simply evaluate
+
+```ruby
+title
+```
+Instead of `Todo.first.title`
+
+Combining this with the `instance` method gives you a way to create a console window on a specific object in your application:
+
+```ruby
+console context: 'App.instance'
+```
+
+Will create a console window whose `self` is your top level application component.
+
+*Note: if no context is provided, the context will be main opal context.*
+
+### Console Titles
+
+You can also give console windows a title:
+
+```ruby
+console text: 'App.instance', title: 'App'
+```
+
+### Loading / Reloading from Javascript
+
+The `hyperconsole` method is added to the javascript window object, so in your application's javascript console you can say `hyperconsole()` to load (or reload) the main hyperconsole window.  When reloading any prior command history will be retained, so this makes a nice escape hatch if things ever become totally confused.
+
+### Loading at Application Boot
+
+By default a console will be created when your page loads.  You can turn this off by setting
+```ruby
+config.console_auto_start = false
+```
+in your hyperloop rails initializer.
+
+You can still start the console using `hyperconsole()` as described above.
+
+### How it works
+
+The console and main application window communicate via two Hyperloop Operations: `Evaluate`, and `Response`.  
+
+As you type, the console runs the Opal compiler in the console window, and when you have a valid ruby expression, the resulting compiled code is sent to the main window using `Evaluate`.  The main window receives the Evaluate dispatch, does a javascript eval and returns the result.  
+
+## Development
+
+After checking out the repo, run bundle install.
+
+The console assets are packaged into a single JS file, and a single style sheet.  Running `rake` will build the packages, and put them in the appropriate directories.
+
+## TODO (help wanted)
+
++ configurable themes, especially smaller font size
++ full keyboard controls (i.e things like ctrl-a moves to beginning of line)
++ remove dependency on `Hyperloop::Application` channel
++ Peer to peer communication once initial connection is made
++ Chrome extension so that console can be attached physically to main window
++ add some kind of test suite, and ability to test without building the asset package
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/hyper-console. 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
+
+Hyperloop gems are released under the [MIT License](http://www.opensource.org/licenses/MIT).