volt-bootbox 0.1.1 → 0.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 43635ebb91e096122a93b1d8126d7e24774f5e39
-  data.tar.gz: c430f7cf230b4a8b08d200f93415752f1358a714
+  metadata.gz: cc34a2a396a45dafa609c3619df44e71aad864a0
+  data.tar.gz: 7ecec7893adffeff764fbe8463f223065bb530a9
 SHA512:
-  metadata.gz: 480b6fea920aa1deef92ce35d14318199f9742e4cbfcfb863666b175c8d0491d4bb8c8d00df28500d27187f832a0f572341e56325fd4343ad5c9707bbd36b728
-  data.tar.gz: 269429d7ad388f36532941d2fada26e36e4e2103c9f63042fcb6945c870b07d8701914b632b23471f3abe0e574dd2df0abf458f20f2d40832f5095df199324e1
+  metadata.gz: 7167d69336c9319c2d6890f32bfc5e72421d8d701144d204e18bfed3c5cd3d482ed79381145c1b202ad44e4c1fae1fb53e7a01a041dd9b829b99df323f9988e6
+  data.tar.gz: 20c0271ec1f4abcbcc83cfbfdc37b070016a2b291d63b870d6027ed4fc0b53152efc63104bcfccd097c899a2a2fec6a44f2dd2687915f7eb2fb1c31b7bf1b9e0

data/README.md

@@ -34,25 +34,51 @@ Next add volt-bootbox to the dependencies.rb file:
 
 ```component 'bootbox'```
 
+The Opal/Ruby interface is largely consistent with the Javascript interface.
+ 
+See http://bootboxjs.com/documentation.html for Javascript library documentation.
+
+Where a method expects a single callback substitute a block for the JS function.
+  
+The value for a `callback:` keyword argument should be a Ruby proc.
+
+Keyword arguments should preserve the JS camelcase (e.g. className:).
+
 ### Examples
 
 ```
 $bootbox.alert('Hello world!') do
   puts 'hello world acknowledged'
 end
+```
 
-$bootbox.alert(title: 'Alert dialog', message: 'Hello world!') do
-  puts 'hello world acknowledged'
-end
+```
+$bootbox.alert(
+  size: 'small', 
+  title: 'Alert', 
+  message: 'Hello world!', 
+  callback: -> {puts 'hello world acknowledged'}
+)
+```
 
+```
 $bootbox.confirm('Are you sure?') do |result|
   puts "user is #{result ? 'sure' : 'unsure'}"
 end
+```
 
-$bootbox.confirm(title: 'Confirmation dialog', message: Are you sure?') do |result|
-  puts "user is #{result ? 'sure' : 'unsure'}"
+```
+$bootbox.confirm(
+  size: 'small', 
+  title: 'Confirmation', 
+  message: 'Are you sure?'
+  callback: ->(result) {
+    puts "user is #{result ? 'sure' : 'unsure'}"
+  }
 end
+```
 
+```
 $bootbox.prompt('What is your name?') do |result|
   if result 
     puts "user's name is '#{result}'"
@@ -60,15 +86,80 @@ $bootbox.prompt('What is your name?') do |result|
     puts "prompt dismissed"
   end  
 end
+```
 
-$bootbox.prompt(title: 'Prompt dialog', message: 'What is your name?', value: 'default name') do |result|
-  if result 
-    puts "user's name is '#{result}'"
-  else
-    puts "prompt dismissed"
-  end  
-end
+```
+$bootbox.prompt(
+  size: 'small', 
+  title: 'Prompt', 
+  message: 'What is your name?', 
+  value: 'default name'),
+  callback: ->(result) {
+    if result 
+      puts "user's name is '#{result}'"
+    else
+      puts "prompt dismissed"
+  } 
+)
+```
 
+```
+$bootbox.dialog(
+  # required
+  message: "I am a custom dialog",
+  
+  # optional - adds a header to the dialog and places this text in an h4 
+  title: "Custom title",
+
+  # optional - allows the user to dismiss the dialog by hitting ESC
+  # which will call this proc 
+  onEscape: -> { puts 'user press escape' },
+  
+  # optional - whether the dialog should be shown immediately
+  show: true,
+  
+  # optional - whether the dialog should be have a backdrop or not
+  backdrop: true,
+
+  # optional - whether to show a close button (default true)
+  closeButton: true,
+  
+  # optional - whether to animate (default true)
+  animate: true,
+  
+  # optional - an additional CSS class to apply to the Bootstrap dialog wrapper
+  className: "my-modal",
+  
+  # optional - a hash of buttons to be shown in the dialog's footer
+  buttons: {
+    
+    success: {
+      # optional - the button label    
+      label: "Success!",
+
+      # optional - an additional CSS class to apply to the button
+      className: "btn-success",
+      
+      # optional - call proc when button is clicked
+      callback: -> { puts 'success!' }
+    },
+    
+    "Danger!": {
+      # no label is provided so the key is used as the button label
+
+      # optional - an additional CSS class to apply to the button
+      className: "btn-danger",
+      
+      callback: -> { puts 'danger!' }
+    },
+
+    # if the only value supplied is a callback proc, 
+    # the key is used as the button label and all
+    # other options are defaulted
+
+    "Warning!": -> { puts 'warning!}
+  }
+)
 ```
 
 `$bootbox` is a global variable. `Volt::Bootbox` may be substituted. 

data/lib/volt/bootbox/version.rb

@@ -1,5 +1,5 @@
 module Volt
   module Bootbox
-    VERSION = '0.1.1'
+    VERSION = '0.1.2'
   end
 end

data/lib/volt/bootbox.rb

@@ -1,18 +1,7 @@
-# If you need to require in code in the gem's app folder, keep in mind that
-# the app is not on the load path when the gem is required.  Use
-# app/{gemname}/config/initializers/boot.rb to require in client or server
-# code.
-#
-# Also, in volt apps, you typically use the lib folder in the
-# app/{componentname} folder instead of this lib folder.  This lib folder is
-# for setting up gem code when Bundler.require is called. (or the gem is
-# required.)
-#
-# If you need to configure volt in some way, you can add a Volt.configure block
-# in this file.
-
 require 'opal/bootbox'
 
+# see http://bootboxjs.com/documentation.html
+
 module Volt
   module Bootbox
     module_function

data/make/build

@@ -1,3 +1,3 @@
 sh make/commit
 gem build volt-bootbox.gemspec
-gem install volt-bootbox-0.1.1.gem
+gem install volt-bootbox-0.1.2.gem

data/make/push

@@ -2,4 +2,4 @@ sh make/build
 # git remote add origin https://github.com/balmoral/volt-bootbox.git
 # git push -u origin master
 git push
-gem push volt-bootbox-0.1.1.gem
+gem push volt-bootbox-0.1.2.gem

data/volt-bootbox.gemspec

@@ -20,7 +20,7 @@ Gem::Specification.new do |spec|
   spec.require_paths = ["lib"]
 
   spec.required_ruby_version = '>= 2.1'
-  spec.add_dependency 'opal-bootbox', '~> 0.1.0'
+  spec.add_dependency 'opal-bootbox', '~> 0.1.2'
 
   # spec.add_runtime_dependency "volt", "~> 0.9.5.pre3"
   # spec.add_development_dependency 'rspec', '~> 3.2.0'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: volt-bootbox
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.1.2
 platform: ruby
 authors:
 - Colin Gunn
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-12-30 00:00:00.000000000 Z
+date: 2015-12-31 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: opal-bootbox
@@ -16,14 +16,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.1.0
+        version: 0.1.2
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.1.0
+        version: 0.1.2
 description: Volt wrapper for Opal-Bootbox which in turn wraps Bootbox Javascript
   library.
 email: