Merge pull request #2 from jadefish/cross-browser-support

Cross browser support

Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    clipboard_presenter_plugin (0.0.1)
+    clipboard_presenter_plugin (0.1.0)
 
 GEM
   remote: https://rubygems.org/
@@ -12,7 +12,7 @@ PLATFORMS
   ruby
 
 DEPENDENCIES
-  bundler (~> 1.16)
+  bundler (~> 1.17.3)
   clipboard_presenter_plugin!
   rake (~> 10.0)
 

LICENSE

@@ -1,4 +1,4 @@
-Copyright 2019 Nick Miller
+Copyright (c) 2019 Nick Miller
 
 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:
 

README.md

@@ -1,5 +1,80 @@
 # clipboard_presenter_plugin
 
-A plugin for [voom/presenters](https://github.com/rx/presenters) which
-provides clipboard interaction via the
-[clipboard API](https://developer.mozilla.org/en-US/docs/Web/API/Clipboard_API).
+The clipboard_presenter_plugin is a plugin for
+[rx/presenters](https://github.com/rx/presenters) which provides clipboard
+interaction.
+
+## Actions
+
+The clipboard_presenter_plugin provides the following actions:
+
+* Copy from an element: `clipboard copy: :some_field`
+* Cut from an element: `clipboard cut: :some_field`
+
+## Usage
+
+Include the clipboard_presenter_plugin either globally via the `plugins`
+configuration setting
+
+```ruby
+# config/initializers/presenters.rb
+Voom::Presenters::Settings.configure do |config|
+  config.presenters.plugins << :clipboard
+  # Now `clipboard` is available in every POM!
+end
+```
+
+or on a per-POM basis via the `plugin` method.
+
+```ruby
+# presenters/foos/view.pom
+Voom::Presenters.define(:view, namespace: :foos) do
+  plugin :clipboard
+
+  # ...
+end
+```
+
+Then, use one of the clipboard actions in an event handler.
+
+```ruby
+text_field id: :my_secret_token do
+  value current_user.super_secret_token
+end
+
+button icon: :file_copy do
+  tooltip 'Copy token'
+
+  event :click do
+    clipboard copy: :my_secret_token
+    snackbar 'Copied token to clipboard!'
+  end
+end
+```
+
+## Browser support
+
+The following browsers are considered officially supported:
+
+* Chrome 42+
+* Edge 12+
+* Firefox 41+
+* Safari 10+
+
+## Building
+
+0. `nvm use && npm i`
+1. `npm run type-check`
+2. Compile TS to JS: `npm run build` (output: `views/clipboard/build`)
+3. Transpile and bundle via Babel and Webpack: `npm run bundle:dev` (output:
+   `dist/bundle.js`)
+
+Or, `npm run watch` to watch `views/clipboard/src` for changes and run steps 1-3 above.
+
+## Contributing
+
+1. Fork it
+2. Branch it
+4. Fix it
+4. PR it
+5. Done!

clipboard_presenter_plugin.gemspec

@@ -18,6 +18,6 @@ Gem::Specification.new do |spec|
   end
   spec.require_paths = ["lib"]
 
-  spec.add_development_dependency "bundler", "~> 1.16"
+  spec.add_development_dependency "bundler", "~> 1.17.3"
   spec.add_development_dependency "rake", "~> 10.0"
 end

demo/clipboard.pom

@@ -8,38 +8,14 @@ Voom::Presenters.define(:clipboard, namespace: :plugins) do
     indented_grid do
       headline 'Copy'
       text_field id: :copy_me do
-        value 'Copy that.'
+        value "Don't copy that floppy!"
       end
       button :copy, type: :raised do
         event :click do
           clipboard copy: :copy_me
         end
       end
     end
-
-    indented_grid do
-      headline 'Cut'
-      text_field id: :cut_me do
-        value 'Prepare to get cut!'
-      end
-      button :cut, type: :raised do
-        event :click do
-          clipboard cut: :cut_me
-        end
-      end
-    end
-
-    indented_grid do
-      headline 'Paste'
-      text_field id: :paste_me do
-        value 'Do not eat paste.'
-      end
-      button :paste, type: :raised do
-        event :click do
-          clipboard paste: :paste_me
-        end
-      end
-    end
   end
 
   attach :code, file: __FILE__

lib/voom/presenters/plugins/clipboard/action.rb

@@ -4,7 +4,7 @@ module Voom
   module Presenters
     module Plugins
       module Clipboard
-        VALID_ACTIONS = %i[cut copy paste].freeze
+        VALID_ACTIONS = %i[cut copy].freeze
 
         class Action < DSL::Components::Actions::Base
           attr_reader :action,

lib/voom/presenters/plugins/clipboard/clipboard_header.erb

@@ -1,3 +1,3 @@
 <script>
-  <%= File.read(File.expand_path('clipboard.js', __dir__)  ) %>
+  <%= File.read(File.expand_path('../../../../../public/bundle.js', __dir__)  ) %>
 </script>

lib/voom/presenters/plugins/clipboard/version.rb

@@ -2,7 +2,7 @@ module Voom
   module Presenters
     module Plugins
       module Clipboard
-        VERSION = '0.0.1'.freeze
+        VERSION = '0.1.0'.freeze
       end
     end
   end

views/clipboard/.babelrc

@@ -0,0 +1,29 @@
+{
+    "presets": [
+        ["@babel/env", {
+            "targets": {
+                "chrome": "42",
+                "edge": "12",
+                "firefox": "41",
+                "ie": "9",
+                "opera": "29",
+                "safari": "10"
+            }
+        }],
+        "@babel/typescript"
+    ],
+    "plugins": [
+        "@babel/proposal-class-properties"
+    ],
+    "sourceType": "unambiguous",
+
+    "env": {
+        "test": {
+            "plugins": [
+                ["@babel/plugin-transform-runtime", {
+                    "regenerator": true
+                }]
+            ]
+        }
+    }
+}

views/clipboard/.gitignore

@@ -0,0 +1,3 @@
+/node_modules
+/build
+coverage

views/clipboard/.nvmrc

@@ -0,0 +1 @@
+v12.16