enu 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2b1f886bc7124afb3308e97ca245f525de0c314ffd01a64978fcfdd039e161ca
-  data.tar.gz: eba9554f9f8e1c4431b9b5caee7f97259b58c428d50ed0413ce96a3729ca0bc1
+  metadata.gz: 9fadd105115f24dc921adfe7185cfc686fe0d81ec048c581a9d194f992b42627
+  data.tar.gz: 37c92078a937aa1ec6383f2f89ae6aef0cfc00b4b640134d76bdeb168f6fa4c9
 SHA512:
-  metadata.gz: 55af3d8c3e08f270259a66a42193187441eed608013d0e9e5a340aac1ebde36ebcb56371ca40e7b9fee31c00a2f4e3a1019fe057efa0f0f54013093bc5d41e1f
-  data.tar.gz: d6c15d8edac06b856c57d4487dce5f6206c084ec3e32f4deb326ff52fe5dda3139f65b4d5527fba860bc6aeba7113cc8f1a0112ed19e514bbe7c9a2395f4b6cc
+  metadata.gz: 7e74d81cdeb09deb48d6bcedbfc38c8baeffd26dd5bcbec32ec3e6c855ca304d13b85e3c027e7e320be330e2e6c2ee455f71baaeb8d48491b8faa41f9bdcaa96
+  data.tar.gz: 78146fc63abc61689c8c4b9f0b3927d7c3a1915c8da76d270acf6a516945b5091c8129cc1baf5428d465e2234bea3d7f7b88b47c82f7827b926d582cb75301c8

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    enu (0.1.0)
+    enu (0.1.1)
 
 GEM
   remote: https://rubygems.org/

data/README.md

@@ -256,6 +256,62 @@ There is a known issue with using custom directories in a Rails application. If
 Spring stopped.
 ```
 
+### Export enum definition to JavaScript
+
+Sometimes it is necessary to use same enum values on the client side, for instance, when you receive data object serializations from API. In this case it is possible to share your enum type definition with JavaScript code.
+
+#### Webpack
+
+Make sure you have [rails-erb-loader](https://github.com/usabilityhub/rails-erb-loader) installed and enabled so your Webpack configuration will process ERB properly. If you use [Webpacker](https://github.com/rails/webpacker) gem, run `bundle exec rails webpacker:install:erb`.
+
+This example will export `PostStatus` enum to a JavaScript object:
+
+```javascript
+// app/javascript/src/enums.js.erb
+export const postStatus = Object.freeze(<%= PostStatus.to_json %>)
+```
+
+`to_json` method generates JSON replresentation for the enum class options:
+
+```json
+{
+  "draft": "draft",
+  "published": "published",
+  "moderated": "moderated",
+  "deleted": "deleted"
+}
+
+```
+
+Use generated object to reference enum values:
+
+```javascript
+import { postStatus } from 'enums'
+
+postStatus.draft  // => "draft"
+```
+
+`Object.freeze()` call in the example above will prevent accidental change of the `postStatus` values. It is optional, though.
+
+#### Rails Assets Pipeline
+
+Same idea:
+
+```javascript
+// app/assets/javascripts/application.js
+
+//= require_self
+//= require_tree ./shared
+
+window.App || (window.App = {});
+```
+
+```javascript
+// app/assets/javascripts/shared/enums.js.erb
+
+App.postStatus = Object.freeze(<%= PostStatus.to_json %>)
+```
+
 ## Development
 
 After checking out the repository, run `bin/setup` to install dependencies. Then, run `rake test` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.

data/lib/enu.rb

@@ -48,6 +48,10 @@ class Enu
       raise "empty enum, sad enum" unless options&.any?
       keys.first
     end
+
+    def to_json
+      keys.map { |key| [key, key] }.to_h.to_json
+    end
   end
 
   private_class_method :new, :option, :options=

data/lib/enu/version.rb

@@ -1,3 +1,3 @@
 class Enu
-  VERSION = "0.1.0"
+  VERSION = "0.1.1"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: enu
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - Alex Musayev
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-08-01 00:00:00.000000000 Z
+date: 2019-08-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler