rails_react_components 0.1.1 → 0.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 4bbfe456c56c0a706ed87a338b97ba4198555f4e
-  data.tar.gz: 8bb44c1352f47e870849dfa74142c912b84ad0da
+  metadata.gz: 761524eb75e57ae4e5a0fa67b06e813a03ef3a3b
+  data.tar.gz: c12c083b9546e8b297fc69fdbbd53b9591e5eadd
 SHA512:
-  metadata.gz: 36b648de21fd051ffa0195aab43ba7c29075d96f36c01f6b14f955d1c4fb160b0a8b6e0b64e1aa60a7d7a4e57c0e24f8cec15aae46a239d5ca2a67fc4eace156
-  data.tar.gz: a74674431e56181a289ac3350ff6ba57e42053f81f3078b561af315d429f73222c470a75195de2fa62766ea40446f6772b4be941f994993a2808b87663b44325
+  metadata.gz: 8210b6d7bca769857da79e3dc3cc2bb39ab565626f88b936d154c05b038cfda2289088ff710d718c05b66c8ced6f5cb4b0bc9d05425ef5758a2a109c5c8c2b6b
+  data.tar.gz: 6aa61fc4d898f675982682d2a40c04ccc05c14c42af02e75d63edd43d811bbf5ad88249a6f98c3cff63aba0251e12d6c6d9b298ad96fba6f0c90cf3e830ac4c9

data/.rubocop.yml

@@ -0,0 +1,25 @@
+AllCops:
+  Exclude:
+    - spec/**/*
+    - bin/**/*
+    - Gemfile
+    - Rakefile
+    - rails_react_components.gemspec
+  TargetRubyVersion: 2.4
+Style/Documentation:
+  Description: 'Document classes and non-namespace modules.'
+  Enabled: false
+Style/StringLiterals:
+  EnforcedStyle: double_quotes
+  SupportedStyles:
+    - double_quotes
+Style/PercentLiteralDelimiters:
+  PreferredDelimiters:
+    default: ()
+    '%i': '()'
+    '%I': '()'
+    '%r': '{}'
+    '%w': '()'
+    '%W': '()'
+Metrics/LineLength:
+  Max: 100

data/.travis.yml

@@ -2,4 +2,9 @@ sudo: false
 language: ruby
 rvm:
   - 2.4.0
-before_install: gem install bundler -v 1.14.6
+before_install:
+  - gem install bundler -v 1.14.6
+  - gem install rubocop
+script:
+  - rspec spec
+  - rubocop

data/README.md

@@ -1,11 +1,52 @@
 # RailsReactComponents
 
-Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/rails_react_components`. To experiment with that code, run `bin/console` for an interactive prompt.
+[![Build Status](https://travis-ci.org/Adam-Stomski/rails_react_components.svg?branch=master)](https://travis-ci.org/Adam-Stomski/rails_react_components)
 
-TODO: Delete this and the text above, and describe your gem
+Component objects for Rails and React with `react_on_rails`
+
+```ruby
+# component class
+class MyComponent < RailsReactComponents::Component
+  prop :name
+  prop :email, on: :user
+  prop :is_ready
+  prop :received_email, as: :got_email
+
+  def name
+    "My name is Rails Component"
+  end
+
+  def is_ready
+    user.ready?
+  end
+
+  def received_email
+    false
+  end
+end
+
+# in view this can run:
+# react_component("MyComponent", 
+#   props: { 
+#     name: "My name is Rails Component",
+#     email: "user@example.com",
+#     isReady: true,
+#     got_email: false
+#   }
+# )
+render_react_component MyComponent, user: current_user 
+```
+
+## TODO
+
+- [ ] - nested props
+- [ ] - Rspec matchers
+- [x] - configuration (snake_case methods for camelCase props etc)
 
 ## Installation
 
+If you are not using `react_on_rails` yet check https://github.com/shakacode/react_on_rails
+
 Add this line to your application's Gemfile:
 
 ```ruby
@@ -20,10 +61,49 @@ Or install it yourself as:
 
     $ gem install rails_react_components
 
+## Configuration
+
+You can add initializer (these are defaults):
+
+```ruby
+  RailsReactComponents.config do |config|
+    config.camelize_props = true # method :some_method will end up someMethod prop
+                                 # when true, only way to prevent this is using prop as: option
+    config.prerender = nil # set global prerender
+    config.raise_on_prerender_error = nil # set global raise_on_prerender_error
+  end
+```
+
 ## Usage
 
-TODO: Write usage instructions here
 
+#### Available options example:
+```ruby
+  class MyComponent < RailsReactComponents::Component
+    component "FilePicker"
+
+    id "file-picker-id"
+
+    html_option "color", "red"
+    html_option "opacity", "0.5"
+
+    prerender
+    trace
+    replay_console
+    raise_on_prerender_error
+
+    prop :blank, include_blank: false
+
+    prop :name, on: :user
+    prop :email, delegate: :user # alias
+
+    def blank
+      ""
+    end
+  end
+```
+
+check also [here](spec/features) and [here](https://github.com/shakacode/react_on_rails#react_component)
 
 ## Contributing
 

data/app/helpers/rails_react_components_helper.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module RailsReactComponentsHelper
   def render_react_component(klass, options = {})
     component = klass.new(options)

data/lib/rails_react_components.rb

@@ -1,7 +1,21 @@
+# frozen_string_literal: true
+
 require "rails"
 require "rails_react_components/engine"
 
 module RailsReactComponents
+  mattr_accessor :camelize_props
+  self.camelize_props = true
+
+  mattr_accessor :prerender
+  self.prerender = nil
+
+  mattr_accessor :raise_on_prerender_error
+  self.raise_on_prerender_error = nil
+
+  def self.config
+    yield self
+  end
 end
 
 require "rails_react_components/version"

data/lib/rails_react_components/component.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require_relative "components/prop"
 require_relative "components/dsl"
 
@@ -18,7 +20,7 @@ module RailsReactComponents
     end
 
     def respond_to_missing?(method_name, include_private = false)
-      _methods.has_key?(method_name.to_sym) || super
+      _methods.key?(method_name.to_sym) || super
     end
 
     def component_options

data/lib/rails_react_components/components/dsl.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module RailsReactComponents
   module Components
     module Dsl
@@ -33,7 +35,17 @@ module RailsReactComponents
         html_options[name] = value
       end
 
-      %w(prerender trace replay_console raise_on_prerender_error).each do |method|
+      %w(prerender raise_on_prerender_error).each do |method|
+        define_method method do
+          instance_variable_set("@_#{method}", true)
+        end
+
+        define_method "#{method}?" do
+          instance_variable_get("@_#{method}") || RailsReactComponents.send(method)
+        end
+      end
+
+      %w(trace replay_console).each do |method|
         define_method method do
           instance_variable_set("@_#{method}", true)
         end

data/lib/rails_react_components/components/prop.rb

@@ -1,18 +1,18 @@
+# frozen_string_literal: true
+
 module RailsReactComponents
   module Components
     class Prop
-      attr_reader :name
-
-      def initialize(name, options)
-        @name = name.to_sym
+      def initialize(method_name, options)
+        @method_name = method_name.to_sym
         @options = options
       end
 
       def build(component)
         if on.present?
-          component.send(on).send(name)
+          component.send(on).send(method_name)
         else
-          component.send(name)
+          component.send(method_name)
         end
       end
 
@@ -20,12 +20,26 @@ module RailsReactComponents
         options.fetch(:include_blank, true)
       end
 
+      def name
+        if as.present?
+          as
+        elsif RailsReactComponents.camelize_props
+          method_name.to_s.camelize(:lower).to_sym
+        else
+          method_name
+        end
+      end
+
       private
 
-      attr_reader :options
+      attr_reader :options, :method_name
 
       def on
-        @on ||= options[:on] || options[:delegate]
+        options[:on] || options[:delegate]
+      end
+
+      def as
+        options.fetch(:as, nil)&.to_sym
       end
     end
   end

data/lib/rails_react_components/engine.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module RailsReactComponents
   class Engine < Rails::Engine
   end

data/lib/rails_react_components/version.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module RailsReactComponents
-  VERSION = "0.1.1"
+  VERSION = "0.1.2"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rails_react_components
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.1.2
 platform: ruby
 authors:
 - Adam Stomski
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2017-04-06 00:00:00.000000000 Z
+date: 2017-04-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -89,6 +89,7 @@ extra_rdoc_files: []
 files:
 - ".gitignore"
 - ".rspec"
+- ".rubocop.yml"
 - ".travis.yml"
 - Gemfile
 - LICENSE.txt