jsimple 0.4.0 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 728305501c6c63dd8d1f564c06fe067335ca39fc
-  data.tar.gz: d642681a7c3e9f7d4b10ea3352491ebb952d7514
+  metadata.gz: 9db9fc244323efa03873ab9863a0cb57d1a70294
+  data.tar.gz: a32b112f272b8cf74500860dfd0b9c00a4f0a7af
 SHA512:
-  metadata.gz: f41318dbf91ac24a627cf495a486765dd0aaadea53cfccc5b32d13c445084fc0d70ffb38875ec9f4b8f268bbfd147389445779051053478b0c18b151dfaa1801
-  data.tar.gz: a97867c73a59c934ce553b7c901970612b80ab838258a20c17a2187b3fa07091ebd90756a51fd3cfb9fcd12c8b7475d147f9ed17a8108664e037775b5147bc65
+  metadata.gz: 1de33604c8219a3f22f9171dc865c38307c4dda41bb8e09f19d887bc58888d21bbb730e5e10b404d954e6a4badddfd21c1beec620f6025cad09d550af0fac3ee
+  data.tar.gz: 2a0488e34f7c3ae0bb2f33bd6ab29dcd6037f0883237c94eb18abb925c1b39a60e75468fe90e28067a03c99c6c8f70a8627cbece9dd69304a7b6198b8d993b28

data/README.md

@@ -22,31 +22,86 @@ Or install it yourself as:
 
 In order to have this make sense with your current setup you probably want to configure some of the defaults.
 
-__Host__: `Jsimple.host = 'localhost'`
+Below are all of the available configuration values and their defaults.
+
+__Host__:
+
+```ruby
+Jsimple.host = 'localhost'
+```
 Server host for the JS client (usually Node) in development mode. Default is localhost.
 
-__Port__: `Jsimple.port = '3100'`
+__Port__:
+
+```ruby
+Jsimple.port = '3100'
+```
 Server port for the JS client (usually Node) in development mode. Default is 3100.
 
-__Development__: `Jsimple.development = false`
-Whether to start Jsimple in development mode. Default is `Rails.env.development?` otherwise false.
+__Development__:
+
+```ruby
+Jsimple.development = false
+```
+Whether to start Jsimple in development mode. The default is false unless your running Rails then `Rails.env.development?` is the default.
 
-__Js_start_command__: `Jsimple.js_start_command = 'start'`
+__JS start command__:
+
+```ruby
+Jsimple.js_start_command = 'start'
+```
 JS function name the legacy app will call to initialize the JS app.
 
+__JS path prefix__:
+
+```ruby
+Jsimple.js_path_prefix = 'jsimple'
+```
+JS path prefix to prepend to the app name in production.
+
+__JS dev path prefix__:
+
+```ruby
+Jsimple.js_dev_path_prefix = ''
+```
+JS path prefix to prepend to the app name in development.
+
+
 ## Usage
 
 ```ruby
 data = {name: 'Alice', age: 26}
 app = Jsimple.app('ContactList', props: data, id: 'contact-list-id')
 app.path
-# => jsimple/test_app.min.js
+# In production
+#   => jsimple/test_app.min.js
+# In development
+#   => http://localhost:3100/test_app.min.js
 app.init
 # => <script>
 #      test_app.start(document.getElementById('contact-list-id'), JSON.parse('{"name": "Alice", "age": 26}'));
 #    </script>
 ```
 
+:warning: _Security note_: XSS is possible if a user is allowed to set arbitrary values to `name` and `id`. `props` is serialized to JSON and should therefore be safe.
+
+#### Rails integration
+
+If your using Rails you get a couple of helper methods are included.
+
+Example
+```
+<%= javascript_indlude_tag jsimple_js_path('js_app_name') %>
+<%= jsimle_js_init('js_app_name') %>
+```
+
+You will need to add the production js bundles to your path.
+
+```ruby
+# config/initializers/assets.rb
+Rails.application.config.assets.precompile += %w( jsimple/* )
+```
+
 ## 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.
@@ -55,7 +110,7 @@ To install this gem onto your local machine, run `bundle exec rake install`. To
 
 ## Contributing
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/jsimple. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](contributor-covenant.org) code of conduct.
+Bug reports and pull requests are welcome on GitHub at https://github.com/buren/jsimple. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](contributor-covenant.org) code of conduct.
 
 ## License
 

data/lib/jsimple.rb

@@ -23,10 +23,14 @@ module Jsimple
   DEFAULT_PORT = '3100'
   DEFAULT_DEVELOPMENT = defined?(Rails) ? Rails.env.development? : false
   DEFAULT_JS_START_COMMAND = 'start'
+  DEFAULT_JS_PATH_PREFIX = 'jsimple'
+  DEFAULT_JS_DEV_PATH_PREFIX = ''
   @host = DEFAULT_HOST
   @port = DEFAULT_PORT
   @development = DEFAULT_DEVELOPMENT
   @js_start_command = DEFAULT_JS_START_COMMAND
+  @js_path_prefix = DEFAULT_JS_PATH_PREFIX
+  @js_dev_path_prefix = DEFAULT_JS_DEV_PATH_PREFIX
 
   def self.host=(host)
     HotReloadProxy::Config.host = host
@@ -46,6 +50,14 @@ module Jsimple
     @js_start_command = js_start_command
   end
 
+  def self.js_path_prefix=(js_path_prefix)
+    @js_path_prefix = js_path_prefix
+  end
+
+  def self.js_dev_path_prefix=(js_dev_path_prefix)
+    @js_dev_path_prefix = js_dev_path_prefix
+  end
+
   def self.host
     @host
   end
@@ -62,10 +74,20 @@ module Jsimple
     @js_start_command
   end
 
+  def self.js_path_prefix
+    @js_path_prefix
+  end
+
+  def self.js_dev_path_prefix
+    @js_dev_path_prefix
+  end
+
   def self.reset!
     @host = DEFAULT_HOST
     @port = DEFAULT_PORT
     @development = DEFAULT_DEVELOPMENT
     @js_start_command = DEFAULT_JS_START_COMMAND
+    @js_path_prefix = DEFAULT_JS_PATH_PREFIX
+    @js_dev_path_prefix = DEFAULT_JS_DEV_PATH_PREFIX
   end
 end

data/lib/jsimple/builder.rb

@@ -30,12 +30,19 @@ module Jsimple
 
     # Path for JS bundle in production
     def self.js_production_path(name)
-      "jsimple/#{name}.min.js"
+      _path_join(Jsimple.js_path_prefix, "#{name}.min.js")
     end
 
     # Path for JS in development
     def self.js_development_path(name, host, port)
-      "http://#{host}:#{port}/#{name}.js"
+      path = _path_join(Jsimple.js_dev_path_prefix, "#{name}.js")
+      "http://#{host}:#{port}/#{path}"
+    end
+
+    # private
+
+    def self._path_join(path, file_name)
+      [path, file_name].reject(&:empty?).join('/')
     end
   end
 end

data/lib/jsimple/version.rb

@@ -1,3 +1,3 @@
 module Jsimple
-  VERSION = '0.4.0'
+  VERSION = '0.5.0'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: jsimple
 version: !ruby/object:Gem::Version
-  version: 0.4.0
+  version: 0.5.0
 platform: ruby
 authors:
 - Jacob Burenstam