fie 0.1.11 → 0.1.12

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: a738ba65dca90aa1244891e027b009a844f57c12
-  data.tar.gz: cc3ce83b850b2511f0b3d6bc2577d2adf2f61a75
+  metadata.gz: d9fa60a840aea7f3c1a20c4d9cf697a435eded6e
+  data.tar.gz: 905bbd23714728292dd2695fe751ba8adc6d14a5
 SHA512:
-  metadata.gz: c6f600905946799d535a638d77321f6291793f3fc901c848ccb83f6b350b7b05800358aa18a81def2f68f7d895385ffb3b1d2e473583e353525089e594b16695
-  data.tar.gz: aa87a41952290b08012b7151ab07ec649925194a35c756fec4beed3593c85b70eb9319d53ac4ff3afd7c53ce860825c2d75fb6858cc3eed25b5c08d60cbe367d
+  metadata.gz: 8f68682ec79d4717894098c6657d18eb1db5be2b5c40320ac431373f1847f44a35dc13bdcbc31ac17b0f81c9b3fd5c0a3235b19ca6308e1880c58d8344952a81
+  data.tar.gz: 4edd883ba3fc1fdf442cd89a834f9a053b18312415d4e69ba1fefc4fd3b861d07faef1fb1ab95ee42a16e8346cdea647b3ac221a1c3dbbfb7c95cb7fd1ff0458

data/README.md

@@ -1,9 +1,9 @@
 # <a href="https://fie.eranpeer.co/" target="_blank"><img src="https://image.ibb.co/c0JaA8/github_fie.jpg" height="200" /></a>
 
 [![Gem Version](https://badge.fury.io/rb/fie.svg)](https://badge.fury.io/rb/fie)
+[![Build Status](https://travis-ci.org/raen79/fie.svg?branch=master)](https://travis-ci.org/raen79/fie)
 [![CodeFactor](https://www.codefactor.io/repository/github/raen79/fie/badge)](https://www.codefactor.io/repository/github/raen79/fie)
 [![Join the chat at https://gitter.im/rails-fie/Lobby](https://badges.gitter.im/rails-fie/Lobby.svg)](https://gitter.im/rails-fie/Lobby?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)
-[![GitHub license](https://img.shields.io/github/license/raen79/fie.svg)](https://github.com/raen79/fie/blob/master/LICENSE)
 [![Beerpay](https://beerpay.io/raen79/fie/badge.svg?style=beer-square)](https://beerpay.io/raen79/fie)
 
 ### Fie is a Rails-centric frontend framework running over a permanent WebSocket connection.
@@ -104,7 +104,7 @@ The project does not use javascript, but opal. To build the opal project (in `li
 
 To transfer gems and node packages to opal, add `Opal.use_gem(gem_name)` or `Opal.append_path('./node_modules/module_name/dist')` in the Rakefile within the `build_opal` task.
 
-The ruby files can be found within `lib\opal` and their development is the same as in any other gem.
+The ruby files can be found within `lib/fie` and their development is the same as in any other gem.
 
 Please add tests if you add new features or resolve bugs.
 

data/lib/fie/commander.rb

@@ -20,13 +20,6 @@ module Fie
         uuid: self.params[:identifier]
     end
 
-    def handle_pool_callbacks(params)
-      subject = params['subject']
-      object = Marshal.load(params['object'])
-
-      run_hook :"#{subject}_pool", object
-    end
-
     def unsubscribed
       redis.del Fie::Commander.commander_name(params[:identifier])
     end
@@ -72,7 +65,7 @@ module Fie
         @@pools_subjects.add(subject)
 
         pool_name = Fie::Pools.pool_name(subject)
-        define_method("#{pool_name}_callback") do |object:|
+        define_method("#{ pool_name }_callback") do |object:|
           @published_object = Marshal.load(object)
           instance_eval(&block)
         end
@@ -83,7 +76,15 @@ module Fie
       end
 
       def method_added(name)
-        super_commander_method_names = [:subscribed, :refresh_view, :identifier, :state, :unsubscribed, :modify_state_using_changelog]
+        super_commander_method_names = [
+          :subscribed,
+          :refresh_view, 
+          :identifier,
+          :state,
+          :unsubscribed,
+          :modify_state_using_changelog,
+          :execute_js_function
+        ]
 
         unless @@disable_override || super_commander_method_names.include?(name)
           @@disable_override = true
@@ -99,7 +100,7 @@ module Fie
           alias_method("sub_#{name}", name)
           remove_method(name)
           define_method(name) do |params|
-            @caller = params['caller'].symbolize_keys
+            @caller = params['caller'].symbolize_keys if params['caller']
             @controller_name = params['controller_name']
             @action_name = params['action_name']
             @connection_uuid = self.params['identifier']

data/lib/fie/state.rb

@@ -58,7 +58,7 @@ module Fie
       redis.set Fie::Commander.commander_name(@uuid), Marshal.dump(self)
 
       rendered_view = ApplicationController.render \
-        "#{@controller_name}/#{@action_name}",
+        "#{ @controller_name }/#{ @action_name }",
         assigns: attributes.merge(fie_controller_name: @controller_name, fie_action_name: @action_name),
         layout: 'fie'
 

data/lib/fie/version.rb

@@ -1,3 +1,3 @@
 module Fie
-  VERSION = "0.1.11"
+  VERSION = "0.1.12"
 end

data/lib/opal/fie/commander.rb

@@ -28,7 +28,7 @@ module Fie
         parameters['subjects'].each do |subject|
           @cable.subscribe_to_pool(subject)
         end
-      when 'publish_to_pools'
+      when 'publish_to_pool'
         subject = parameters['subject']
         object = parameters['object']
 
@@ -36,7 +36,7 @@ module Fie
       when 'execute_function'
         Util.exec_js(parameters['name'], parameters['arguments'])
       else
-        console.log("Command: #{ command }, Parameters: #{ parameters }")
+        puts "Command: #{ command }, Parameters: #{ parameters }"
       end
     end
   end

data/spec/fie/commander_spec.rb

@@ -0,0 +1,3 @@
+RSpec.describe Fie::Commander do
+  
+end

data/spec/fie/state_spec.rb

@@ -0,0 +1,173 @@
+RSpec.describe Fie::State do
+  before do
+    credentials = {
+      secret_key_base: 'c2c3f440e947a5592acaad052e756d87dd8db717275ef14ac794a3c2a07cbdaec8aa0df7a090c1bc83833736ee3f5209affe55639845871081d48598d57de3f7'
+    }
+
+    allow(Rails.application).to receive(:credentials) { credentials }
+
+    @unencrypted_variables = {
+      users: [
+        { name: 'eran', age: '20' },
+        User.new(name: 'eran', age: '20'),
+        '120'
+      ],
+      primitive: '120',
+      hash: {
+        array: [1, 2, 3],
+        primitive: '120'
+      }
+    }
+  end
+
+  let(:view_variables) do
+    @unencrypted_variables.map do |key, value|
+      [key, encrypt(value)]
+    end.to_h
+  end
+
+  let(:controller_name) { 'home_controller' }
+  let(:action_name) { 'index' }
+  let(:uuid) { SecureRandom.uuid }
+  let(:attributes) { nil }
+
+  let(:state) do
+    Fie::State.new \
+      view_variables: view_variables,
+      controller_name: controller_name,
+      action_name: action_name,
+      uuid: uuid,
+      attributes: attributes
+  end
+
+  subject { state }
+
+  context "when view_variables == #{ @unencrypted_variables.to_json }" do
+    [:users, :primitive, :hash].each do |variable_name|
+      it { is_expected.to respond_to(variable_name) }
+      it { is_expected.to respond_to("#{ variable_name }=") }
+    end
+
+    describe 'marshalling' do
+      let(:marshalled) { Marshal.dump state }
+      let(:unmarshalled) { Marshal.load marshalled }
+
+      subject { unmarshalled.attributes.to_json }
+
+      it { is_expected.to eq(state.attributes.to_json) }
+    end
+
+    describe 'permeate' do
+      it 'should render an html template which is then sent over action cable' do
+        expect(ApplicationController).to receive(:render).with(
+          "#{ controller_name }/#{ action_name }",
+          assigns: state.attributes.merge(fie_controller_name: controller_name, fie_action_name: action_name),
+          layout: 'fie'
+        ).and_return('long HTML string')
+        
+        expect(ActionCable.server).to receive(:broadcast).with \
+          "commander_#{ uuid }",
+          command: 'refresh_view',
+          parameters: {
+            html: 'long HTML string'
+          }
+
+        state.permeate
+      end
+    end
+
+    describe '`hash`' do
+      before { expect(state).to receive(:permeate) }
+
+      context 'when setting value' do
+        subject { state.hash }
+        let!(:change_value) { state.hash = 'value' }
+
+        it { is_expected.to eq('value') }
+      end
+
+      context 'when deleting value' do
+        let(:delete_value) { state.hash.delete :primitive }
+        it { expect { delete_value }.to change { state.hash.count }.by(-1) }
+      end
+
+      describe 'primitive' do
+        context 'when setting value' do
+          subject { state.hash[:primitive] }
+          let!(:change_hash_value) { state.hash[:primitive] = 'value' }
+
+          it { is_expected.to eq('value') }
+        end
+      end
+    end
+
+    describe '`users`' do
+      before { expect(state).to receive(:permeate) }
+
+      context 'when setting value' do
+        subject { state.users }
+        let!(:change_value) { state.users = 'value' }
+
+        it { is_expected.to eq('value') }
+      end
+
+      describe 'first index' do
+        context 'when setting value' do
+          subject { state.users[0] }
+          let!(:change_array_value) { state.users[0] = 'value' }
+
+          it { is_expected.to eq('value') }
+        end
+        
+        describe 'name attribute' do
+          context 'when setting value' do
+            subject { state.users[0][:name] }
+            let!(:change_hash_value) { state.users[0][:name] = 'value' }
+
+            it { expect(state.users[0][:name]).to eq('value') }
+          end
+        end
+
+        context 'when appending' do
+          let(:append1) { state.users << 'value' }
+          let(:append2) { state.users.push('value') }
+
+          it { expect { append1 }.to change { state.users.count }.by(1) }
+          it { expect { append2 }.to change { state.users.count }.by(1) }
+        end
+
+        context 'when deleting a value' do
+          let(:delete_value) { state.users.delete '120' }
+          it { expect { delete_value }.to change { state.users.count }.by(-1) }
+        end
+
+        context 'when deleting an index' do
+          let(:delete_value) { state.users.delete_at 1 }
+          it { expect { delete_value }.to change { state.users.count }.by(-1) }
+        end
+      end
+    end
+
+    describe 'attributes' do
+      describe 'users' do
+        subject { state.attributes['users'] }
+        
+        it { is_expected.to include a_hash_including(name: 'eran', age: '20') }
+        it { is_expected.to include an_object_having_attributes(name: 'eran', age: '20') }
+        it { is_expected.to include '120' }
+      end
+
+      describe 'primitive' do
+        subject { state.attributes['primitive'] }
+        it { is_expected.to eq('120') }
+      end
+
+      describe 'hash' do
+        subject { state.attributes['hash'] }
+
+        it { is_expected.to include(array: [1, 2, 3]) }
+        it { is_expected.to include(primitive: '120') }
+      end
+    end
+  end
+end

data/spec/rails_helper.rb

@@ -0,0 +1,37 @@
+# This file is copied to spec/ when you run 'rails generate rspec:install'
+require 'spec_helper'
+
+ENV['RAILS_ENV'] ||= 'test'
+require File.expand_path('../../config/environment', __FILE__)
+# Prevent database truncation if the environment is production
+abort("The Rails environment is running in production mode!") if Rails.env.production?
+require 'rspec/rails'
+
+Dir['./spec/fie/*_spec.rb'].each {|file| require file }
+Dir['./spec/support/*.rb'].each {|file| require file }
+Dir['./spec/test_controllers/*.rb'].each {|file| require file }
+Dir['./spec/test_models/*.rb'].each {|file| require file }
+
+RSpec.configure do |config|
+  config.include HelperMethods
+
+  # RSpec Rails can automatically mix in different behaviours to your tests
+  # based on their file location, for example enabling you to call `get` and
+  # `post` in specs under `spec/controllers`.
+  #
+  # You can disable this behaviour by removing the line below, and instead
+  # explicitly tag your specs with their type, e.g.:
+  #
+  #     RSpec.describe UsersController, :type => :controller do
+  #       # ...
+  #     end
+  #
+  # The different available types are documented in the features, such as in
+  # https://relishapp.com/rspec/rspec-rails/docs
+  config.infer_spec_type_from_file_location!
+
+  # Filter lines from Rails gems in backtraces.
+  config.filter_rails_from_backtrace!
+  # arbitrary gems may also be filtered via:
+  # config.filter_gems_from_backtrace("gem name")
+end

data/spec/spec_helper.rb

@@ -0,0 +1,97 @@
+# This file was generated by the `rails generate rspec:install` command. Conventionally, all
+# specs live under a `spec` directory, which RSpec adds to the `$LOAD_PATH`.
+# The generated `.rspec` file contains `--require spec_helper` which will cause
+# this file to always be loaded, without a need to explicitly require it in any
+# files.
+#
+# Given that it is always loaded, you are encouraged to keep this file as
+# light-weight as possible. Requiring heavyweight dependencies from this file
+# will add to the boot time of your test suite on EVERY test run, even for an
+# individual file that may not need all of that loaded. Instead, consider making
+# a separate helper file that requires the additional dependencies and performs
+# the additional setup, and require it from the spec files that actually need
+# it.
+#
+# See http://rubydoc.info/gems/rspec-core/RSpec/Core/Configuration
+
+RSpec.configure do |config|
+  # rspec-expectations config goes here. You can use an alternate
+  # assertion/expectation library such as wrong or the stdlib/minitest
+  # assertions if you prefer.
+  config.expect_with :rspec do |expectations|
+    # This option will default to `true` in RSpec 4. It makes the `description`
+    # and `failure_message` of custom matchers include text for helper methods
+    # defined using `chain`, e.g.:
+    #     be_bigger_than(2).and_smaller_than(4).description
+    #     # => "be bigger than 2 and smaller than 4"
+    # ...rather than:
+    #     # => "be bigger than 2"
+    expectations.include_chain_clauses_in_custom_matcher_descriptions = true
+  end
+
+  # rspec-mocks config goes here. You can use an alternate test double
+  # library (such as bogus or mocha) by changing the `mock_with` option here.
+  config.mock_with :rspec do |mocks|
+    # Prevents you from mocking or stubbing a method that does not exist on
+    # a real object. This is generally recommended, and will default to
+    # `true` in RSpec 4.
+    mocks.verify_partial_doubles = true
+  end
+
+  # This option will default to `:apply_to_host_groups` in RSpec 4 (and will
+  # have no way to turn it off -- the option exists only for backwards
+  # compatibility in RSpec 3). It causes shared context metadata to be
+  # inherited by the metadata hash of host groups and examples, rather than
+  # triggering implicit auto-inclusion in groups with matching metadata.
+  config.shared_context_metadata_behavior = :apply_to_host_groups
+
+# The settings below are suggested to provide a good initial experience
+# with RSpec, but feel free to customize to your heart's content.
+=begin
+  # This allows you to limit a spec run to individual examples or groups
+  # you care about by tagging them with `:focus` metadata. When nothing
+  # is tagged with `:focus`, all examples get run. RSpec also provides
+  # aliases for `it`, `describe`, and `context` that include `:focus`
+  # metadata: `fit`, `fdescribe` and `fcontext`, respectively.
+  config.filter_run_when_matching :focus
+
+  # Allows RSpec to persist some state between runs in order to support
+  # the `--only-failures` and `--next-failure` CLI options. We recommend
+  # you configure your source control system to ignore this file.
+  config.example_status_persistence_file_path = "spec/examples.txt"
+
+  # Limits the available syntax to the non-monkey patched syntax that is
+  # recommended. For more details, see:
+  #   - http://rspec.info/blog/2012/06/rspecs-new-expectation-syntax/
+  #   - http://www.teaisaweso.me/blog/2013/05/27/rspecs-new-message-expectation-syntax/
+  #   - http://rspec.info/blog/2014/05/notable-changes-in-rspec-3/#zero-monkey-patching-mode
+  config.disable_monkey_patching!
+
+  # Many RSpec users commonly either run the entire suite or an individual
+  # file, and it's useful to allow more verbose output when running an
+  # individual spec file.
+  if config.files_to_run.one?
+    # Use the documentation formatter for detailed output,
+    # unless a formatter has already been configured
+    # (e.g. via a command-line flag).
+    config.default_formatter = "doc"
+  end
+
+  # Print the 10 slowest examples and example groups at the
+  # end of the spec run, to help surface which specs are running
+  # particularly slow.
+  config.profile_examples = 10
+
+  # Run specs in random order to surface order dependencies. If you find an
+  # order dependency and want to debug it, you can fix the order by providing
+  # the seed, which is printed after each run.
+  #     --seed 1234
+  config.order = :random
+
+  # Seed global randomization in this process using the `--seed` CLI option.
+  # Setting this allows you to use `--seed` to deterministically reproduce
+  # test failures related to randomization by passing the same `--seed` value
+  # as the one that triggered the failure.
+  Kernel.srand config.seed
+=end
+end

data/spec/support/helper_methods.rb

@@ -0,0 +1,13 @@
+module HelperMethods
+  def encryptor
+    ActiveSupport::MessageEncryptor.new Rails.application.credentials[:secret_key_base]
+  end
+
+  def encrypt(value)
+    encryptor.encrypt_and_sign Marshal.dump(value)
+  end
+  
+  def decrypt(value)
+    Marshal.load encryptor.decrypt_and_verify(value)
+  end
+end

data/spec/test_controllers/application_controller.rb

@@ -0,0 +1,4 @@
+class ApplicationController
+  def self.render(action, assigns:, layout:)
+  end
+end