styxie 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 5d2156cfb84c6af5e34dc8519e9c45cddbfe9c1f
+  data.tar.gz: f4b9bcb8b735cc5285fa1fbe75828db219e5c121
+SHA512:
+  metadata.gz: abdd26d978c1334c0138bf9fefd442f0ec21c39f5af03c5ad8eccd2aa66064538237fb09265af1f2e8e09167552dcb00ed3f42faf3e44ab066dd72d96452c4a1
+  data.tar.gz: 6588c7c4ea55f3aacad4cdace62cfb55a4e3e4bf590e4ecf13a72991c086f05f88481442ee9ec20e6a5970e834fec0a3d6487e984aac5329ce5f4857e08b3689

data/.gitignore

@@ -0,0 +1,53 @@
+.idea/
+.rspec
+
+*.gem
+*.rbc
+/.config
+/coverage/
+/InstalledFiles
+/pkg/
+/spec/reports/
+/spec/examples.txt
+/test/tmp/
+/test/version_tmp/
+/tmp/
+
+# Used by dotenv library to load environment variables.
+# .env
+
+## Specific to RubyMotion:
+.dat*
+.repl_history
+build/
+*.bridgesupport
+build-iPhoneOS/
+build-iPhoneSimulator/
+
+## Specific to RubyMotion (use of CocoaPods):
+#
+# We recommend against adding the Pods directory to your .gitignore. However
+# you should judge for yourself, the pros and cons are mentioned at:
+# https://guides.cocoapods.org/using/using-cocoapods.html#should-i-check-the-pods-directory-into-source-control
+#
+# vendor/Pods/
+
+## Documentation cache and generated files:
+/.yardoc/
+/_yardoc/
+/doc/
+/rdoc/
+
+## Environment normalization:
+/.bundle/
+/vendor/bundle
+/lib/bundler/man/
+
+# for a library or gem, you might want to ignore these files since the code is
+# intended to run in multiple environments; otherwise, check them in:
+Gemfile.lock
+.ruby-version
+.ruby-gemset
+
+# unless supporting rvm < 1.11.0 or doing something fancy, ignore this:
+.rvmrc

data/.rubocop.yml

@@ -0,0 +1,299 @@
+AllCops:
+  TargetRubyVersion: 2.3
+
+Style/EmptyLinesAroundClassBody:
+  Enabled: true
+  EnforcedStyle: empty_lines
+
+Style/SpaceAroundEqualsInParameterDefault:
+  Enabled: true
+
+Style/SymbolLiteral:
+  Enabled: true
+
+Style/SpaceAroundOperators:
+  Enabled: true
+
+Style/ParallelAssignment:
+  Enabled: true
+
+Style/NumericLiterals:
+  MinDigits: 14
+
+Style/Not:
+  Enabled: true
+
+Style/ClosingParenthesisIndentation:
+  Enabled: false
+
+Style/SpaceAfterComma:
+  Enabled: true
+
+Style/SpaceInsideBrackets:
+  Enabled: false
+
+Style/SpaceInsideParens:
+  Enabled: true
+
+Style/SpaceBeforeFirstArg:
+  Enabled: true
+
+Style/MultilineOperationIndentation:
+  Enabled: false
+
+Style/MethodDefParentheses:
+  Enabled: true
+
+Style/MethodCallParentheses:
+  Enabled: true
+
+Style/LineEndConcatenation:
+  Enabled: true
+
+Style/LeadingCommentSpace:
+  Enabled: true
+
+Style/AlignArray:
+  Enabled: false
+
+Style/AlignHash:
+  Enabled: false
+
+Style/CaseIndentation:
+  Enabled: true
+
+Style/GuardClause:
+  Enabled: false
+
+Style/HashSyntax:
+  EnforcedStyle: ruby19
+
+Style/RedundantSelf:
+  Enabled: true
+
+Lint/DeprecatedClassMethods:
+  Enabled: true
+
+Style/NilComparison:
+  Enabled: true
+
+Style/EmptyLineBetweenDefs:
+  Enabled: true
+
+Style/EmptyLines:
+  Enabled: true
+
+Style/EmptyLinesAroundAccessModifier:
+  Enabled: true
+
+Style/EmptyLiteral:
+  Enabled: true
+
+Style/For:
+  Enabled: true
+
+Lint/AssignmentInCondition:
+  Enabled: true
+
+Lint/BlockAlignment:
+  Enabled: true
+
+Lint/LiteralInCondition:
+  Enabled: true
+
+Lint/Loop:
+  Enabled: true
+
+Lint/ParenthesesAsGroupedExpression:
+  Enabled: true
+
+Lint/RescueException:
+  Enabled: true
+
+Lint/ShadowingOuterLocalVariable:
+  Enabled: false
+
+Lint/UnusedBlockArgument:
+  Enabled: true
+
+Lint/UnusedMethodArgument:
+  Enabled: true
+
+Lint/UselessAssignment:
+  Enabled: true
+
+Lint/Void:
+  Enabled: true
+
+Style/StringLiterals:
+  Enabled: true
+
+Lint/AmbiguousRegexpLiteral:
+  Enabled: true
+
+Lint/Debugger:
+  Enabled: true
+
+Lint/EndAlignment:
+  Enabled: true
+
+Lint/HandleExceptions:
+  Enabled: true
+
+Lint/StringConversionInInterpolation:
+  Enabled: true
+
+Style/SpaceInsideHashLiteralBraces:
+  Enabled: true
+
+Style/SpaceInsideBlockBraces:
+  Enabled: true
+  SpaceBeforeBlockParameters: false
+
+Style/SpaceBeforeBlockBraces:
+  Enabled: true
+
+Style/BracesAroundHashParameters:
+  Enabled: false
+
+Style/TrailingBlankLines:
+  Enabled: true
+
+Style/TrailingWhitespace:
+  Enabled: true
+
+Lint/UnderscorePrefixedVariableName:
+  Enabled: true
+
+Lint/UselessAccessModifier:
+  Enabled: true
+
+Metrics/BlockNesting:
+  Max: 3
+
+Metrics/ClassLength:
+  Max: 160
+
+Metrics/CyclomaticComplexity:
+  Max: 10
+
+Style/CommentAnnotation:
+  Enabled: true
+
+Style/CommentIndentation:
+  Enabled: true
+
+Style/DeprecatedHashMethods:
+  Enabled: true
+
+Style/Documentation:
+  Enabled: false
+
+Style/DotPosition:
+  Enabled: true
+
+Lint/AmbiguousOperator:
+  Enabled: true
+
+Metrics/AbcSize:
+  Max: 80
+
+Metrics/LineLength:
+  Max: 160
+
+Metrics/MethodLength:
+  Max: 50
+
+Metrics/ParameterLists:
+  Enabled: true
+  CountKeywordArgs: false
+
+Metrics/PerceivedComplexity:
+  Max: 12
+
+Metrics/ModuleLength:
+  Max: 150
+
+Style/Alias:
+  Enabled: true
+
+Style/AlignParameters:
+  Enabled: false
+
+Style/AndOr:
+  Enabled: false
+
+Style/AsciiComments:
+  Enabled: true
+
+Style/ClassAndModuleChildren:
+  Enabled: false
+
+Style/DoubleNegation:
+  Enabled: false
+
+Style/EmptyLinesAroundMethodBody:
+  Enabled: false
+
+Style/EmptyLinesAroundModuleBody:
+  Enabled: false
+
+Style/IfUnlessModifier:
+  Enabled: true
+
+Style/FormatString:
+  Enabled: false
+
+Style/IndentArray:
+  Enabled: true
+
+Style/IndentHash:
+  Enabled: false
+
+Style/IndentationConsistency:
+  Enabled: true
+
+Style/IndentationWidth:
+  Enabled: true
+
+Style/Lambda:
+  Enabled: false
+
+Style/PercentLiteralDelimiters:
+  Enabled: true
+
+Style/PredicateName:
+  Enabled: false
+
+Style/RaiseArgs:
+  Enabled: false
+
+Style/RedundantReturn:
+  Enabled: true
+
+Style/RegexpLiteral:
+  Enabled: true
+
+Style/RescueModifier:
+  Enabled: false
+
+Style/Semicolon:
+  Enabled: true
+
+Style/SpaceAfterMethodName:
+  Enabled: true
+
+Style/SymbolProc:
+  Enabled: true
+
+Style/TrailingCommaInLiteral:
+  Enabled: true
+
+Style/TrailingCommaInArguments:
+  Enabled: true
+
+Style/TrivialAccessors:
+  Enabled: true
+
+Style/StructInheritance:
+  Enabled: false

data/.travis.yml

@@ -0,0 +1,10 @@
+language: ruby
+rvm:
+  - 2.3.1
+install: "bundle install --path vendor/bundle"
+cache:
+  directories:
+    - vendor/bundle
+script: "TRAVIS_CI=true bundle exec rspec --tag ~listen"
+os:
+  - linux

data/Dockerfile

@@ -0,0 +1,7 @@
+FROM httplab/ruby-dev-app:2.3
+
+VOLUME $HOME/$APP
+
+USER $USER
+
+CMD [ "irb" ]

data/Gemfile

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+source 'http://rubygems.org'
+
+gemspec
+
+group :development, :test do
+  gem 'combustion', '~> 0.3.1'
+  gem 'capybara'
+  gem 'rspec-rails'
+  gem 'rubocop'
+  gem 'rake'
+  gem 'pry'
+  gem 'codecov', require: false
+  gem 'mutant-rspec'
+end

data/LICENSE

@@ -0,0 +1,22 @@
+The MIT License
+
+Copyright (c) 2012 Round Lake, inc.,
+                   Peter Zotov <whitequark@whitequark.org>.
+
+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:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,79 @@
+# Styxie
+
+Bridge between Server side and Client (JS) side which is divided into several modules:
+
+* **Helpers**: set of helpers to support all other modules.
+* **Initializer**: organizes JS into bootstrap classes and allows you to pass data from controller/view.
+
+## Installation
+
+In your Gemfile, add this line:
+
+    gem 'styxie'
+    
+In your assets application.js include appropriate libs:
+
+    //= require styx           <- Helpers and Initializers
+
+## Basic Usage
+
+```ruby
+# app/controllers/foos_controller.rb
+class FoosController < ApplicationController
+  include Styxie::Initializer
+end
+```
+
+Include modules to ApplicationController if you want to use it everywhere.
+
+
+### Initializer
+
+In common each controller in Rails comes with *app/assets/javascripts/controller_name.js.coffee*. 
+**Styxie.Initializer** allows you to define bootstrap logic for each Rails action separately and 
+pass some data from server right into it.
+
+To enable initializers bootstrap, add *styx_initialize* call into your layout:
+
+```erb
+  <head>
+    <title>Rails Application</title>
+    <%= stylesheet_link_tag    "application" %>
+    <%= javascript_include_tag "application" %>
+    <%= styx_initialize %>
+    <%= csrf_meta_tags %>
+```
+
+Imagine you have controller *Foos* and therefore *app/assets/javascripts/foos.js.coffee* file.
+
+```coffee-script
+@Styxie.Initializers.Foos =
+  initialize: ->
+    console.log 'This will be called in foos#ANY action after <head> was parsed'
+      
+  index: (data) ->
+    console.log 'This will be called in foos#index action after <head> was parsed'
+    
+  show: (data) -> 
+    $ ->
+      console.log 'This will be called in foos#show action after the page was loaded'
+```
+
+Note that any method besides common *initialize* has the *data* parameter. To pass some data to your
+initializers you can use *styxie_initialize_with* helper in your controller or views. Like that:
+
+```ruby
+# app/controllers/foos_controller.rb
+class FoosController < ApplicationController
+  def index
+    styx_initialize_with some: 'data', and: { even: 'more data' }
+  end
+end
+
+# app/views/foos/index.html.erb
+<%- styx_initialize_with enabled: true %>
+```
+
+As the result *Styxie.Initializers.Foos->index* will be called with data equal to 
+
+    {some: data, and: {even: 'mode data'}, enabled: true}

data/Rakefile

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+require 'rubygems'
+require 'bundler'
+Bundler.require :development
+require 'rake'
+require 'rspec/core/rake_task'
+
+task RSpec::Core::RakeTask.new(:spec)

data/app/assets/javascripts/styxie.js.coffee

@@ -0,0 +1,22 @@
+@Styxie = {
+  Initializers: {}
+}
+
+@Styxie.URL =
+  go: (url, force=false) ->
+    # 'Force' required if you want to reload same page with another anchor
+    url = this.build(url, "reloadthispagepls=#{Math.random()}") if force
+    window.location.href = url
+
+  build: (url, params) ->
+    hash = url.match(/\#.*$/)
+    hash = if hash then hash[0] else false
+
+    url = url.replace(hash, '') if hash
+    url = url + "?" if url.indexOf("?") == -1
+
+    url = "#{url}&#{params}"
+
+    url = url + hash if hash
+
+    return url

data/app/views/styxie/_initializer.html.erb

@@ -0,0 +1,12 @@
+<script type="text/javascript">
+//<![CDATA[
+  if (Styxie.Initializers.<%=klass%> && Styxie.Initializers.<%=klass%>.initialize)
+  {
+    Styxie.Initializers.<%=klass%>.initialize(<%=data.to_json.html_safe%>);
+  }
+  if (Styxie.Initializers.<%=klass%> && Styxie.Initializers.<%=klass%>['<%=method%>'])
+  {
+    Styxie.Initializers.<%=klass%>['<%=method%>'](<%=data.to_json.html_safe%>);
+  }
+//]]>
+</script>

data/docker-compose.yml

@@ -0,0 +1,5 @@
+dev:
+  build: .
+  volumes:
+    - .:/home/apps/app
+    - ~/data/gems-2.3:/.gem

data/init.rb

@@ -0,0 +1,2 @@
+# frozen_string_literal: true
+require 'styxie'

data/lib/styxie/engine.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+module Styxie #:nodoc:
+  class Engine < ::Rails::Engine #:nodoc:
+  end
+end

data/lib/styxie/helpers.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+module Styxie
+  module Helpers
+    def this_page?(mask)
+      Array(mask).any? do |m|
+        c, a = m.to_s.split('#')
+        !(c.present? && c != controller_name || a.present? && a != action_name)
+      end
+    end
+
+    def this_namespace?(namespace)
+      # TODO: support nested namespaces?
+      namespace == controller_path.split('/').first
+    end
+  end
+end

data/lib/styxie/initializer.rb

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+module Styxie
+  module Initializer
+    def styxie_initialize_with(data)
+      styxie_configuration.merge! data
+    end
+
+    def styxie_initialize(klass: styxie_class, method: action_name, data: styxie_configuration)
+      result = render_to_string partial: 'styxie/initializer', locals: {
+        klass: klass,
+        method: method,
+        data: data
+      }
+
+      result.html_safe
+    end
+
+    def styxie_configuration
+      @styxie_initialize_with ||= {}
+    end
+
+    def styxie_class
+      controller_path.tr('/', '_').camelize
+    end
+  end
+end

data/lib/styxie.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+module Styxie
+
+  require 'styxie/engine' if defined?(Rails)
+  require 'styxie/helpers'
+  require 'styxie/initializer'
+
+end

data/spec/controllers/tests_controller_spec.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+require 'spec_helper'
+
+describe TestsController, type: :controller do
+  render_views
+
+  it 'index' do
+    get :index
+    response.body.should have_content('Styxie.Initializers.Tests.initialize({"data":"test"})')
+    response.body.should have_content('Styxie.Initializers.Tests[\'index\']({"data":"test"})')
+  end
+end

data/spec/internal/app/controllers/tests_controller.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+require 'styxie'
+
+class TestsController < ActionController::Base
+
+  append_view_path Styxie::Engine.paths['app/views']
+
+  include Styxie::Initializer
+  helper_method :styxie_initialize
+
+  def index
+    styxie_initialize_with data: 'test'
+  end
+
+end

data/spec/internal/app/views/tests/index.html.erb

@@ -0,0 +1 @@
+<%= styxie_initialize %>

data/spec/internal/config/routes.rb

@@ -0,0 +1,4 @@
+# frozen_string_literal: true
+Rails.application.routes.draw do
+  resources :tests
+end

data/spec/internal/log/.gitignore

@@ -0,0 +1 @@
+*.log

data/spec/lib/styxie_helpers_spec.rb

@@ -0,0 +1,63 @@
+# frozen_string_literal: true
+require 'spec_helper'
+
+describe Styxie::Helpers do
+  let :controller do
+    controller = double('controller')
+    controller.class_eval do
+      include Styxie::Helpers
+    end
+
+    controller
+  end
+
+  it '#this_page?' do
+    controller.stub(controller_name: 'tests')
+    controller.stub(action_name: 'index')
+
+    cases = [
+      [
+        be_truthy, [
+          'tests#index',
+          '#index'
+        ]
+      ], [
+        be_falsy, [
+          'fails#index',
+          'tests#show',
+          '#show'
+        ]
+      ]
+    ]
+
+    cases.each do |group|
+      be_ok, examples = group
+      examples.each do |example|
+        expect(controller.this_page?(example)).to be_ok
+      end
+    end
+  end
+
+  it '#this_namespace?' do
+    controller.stub(controller_path: 'module/tests')
+
+    cases = [
+      [
+        be_truthy, [
+          'module'
+        ]
+      ], [
+        be_falsy, [
+          'whatever'
+        ]
+      ]
+    ]
+
+    cases.each do |group|
+      be_ok, examples = group
+      examples.each do |example|
+        expect(controller.this_namespace?(example)).to be_ok
+      end
+    end
+  end
+end

data/spec/lib/styxie_initializer_spec.rb

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+require 'spec_helper'
+
+describe Styxie::Initializer do
+  let :controller do
+    controller = double('controller')
+    controller.class_eval do
+      include Styxie::Initializer
+    end
+
+    controller
+  end
+
+  it '#styxie_initialize_with' do
+    expect(controller.styxie_configuration).to eq({})
+    controller.styxie_initialize_with(test: 'data')
+    expect(controller.styxie_configuration).to eq({ test: 'data' })
+  end
+
+  it '#styxie_initialize' do
+    controller.stub(controller_path: 'module/tests')
+    controller.stub(action_name: 'index')
+    controller.should_receive(:render_to_string).and_return('rendered template')
+    result = controller.styxie_initialize
+    expect(result).to eq 'rendered template'
+    expect(result.html_safe?).to be_truthy
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+require 'rubygems'
+require 'bundler'
+Bundler.require :development
+require 'capybara/rspec'
+Combustion.initialize! :action_controller, :action_view, :sprockets
+Bundler.require :default
+require 'rspec/rails'
+require 'capybara/rails'
+
+RSpec.configure do |config|
+  config.mock_with :rspec
+end

data/styxie.gemspec

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+Gem::Specification.new do |s|
+  s.name        = 'styxie'
+  s.version     = '0.0.1'
+  s.platform    = Gem::Platform::RUBY
+  s.summary     = 'Set of helpers to maintain bridge between Server side and Client (JS) side'
+  s.email       = 'dev@httplab.ru'
+  s.homepage    = 'http://github.com/httplab/styxie'
+  s.description = s.summary
+  s.authors     = ['Yury Kotov', 'Httplab']
+
+  s.has_rdoc = false # disable rdoc generation until we've got more
+  s.files         = `git ls-files`.split("\n")
+  s.require_paths = ['lib']
+end

metadata

@@ -0,0 +1,70 @@
+--- !ruby/object:Gem::Specification
+name: styxie
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Yury Kotov
+- Httplab
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2016-09-03 00:00:00.000000000 Z
+dependencies: []
+description: Set of helpers to maintain bridge between Server side and Client (JS)
+  side
+email: dev@httplab.ru
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rubocop.yml"
+- ".travis.yml"
+- Dockerfile
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- app/assets/javascripts/styxie.js.coffee
+- app/views/styxie/_initializer.html.erb
+- docker-compose.yml
+- init.rb
+- lib/styxie.rb
+- lib/styxie/engine.rb
+- lib/styxie/helpers.rb
+- lib/styxie/initializer.rb
+- spec/controllers/tests_controller_spec.rb
+- spec/internal/app/controllers/tests_controller.rb
+- spec/internal/app/views/tests/index.html.erb
+- spec/internal/config/routes.rb
+- spec/internal/db/schema.rb
+- spec/internal/log/.gitignore
+- spec/lib/styxie_helpers_spec.rb
+- spec/lib/styxie_initializer_spec.rb
+- spec/spec_helper.rb
+- styxie.gemspec
+homepage: http://github.com/httplab/styxie
+licenses: []
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.5.1
+signing_key: 
+specification_version: 4
+summary: Set of helpers to maintain bridge between Server side and Client (JS) side
+test_files: []