rails_stuff 0.2.0 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: c06d5c2ac89db00eb5633892fdf69367b9e9ced5
-  data.tar.gz: f0ba6b7bf860d9bb0931f9b8cb547df9f016ba7b
+  metadata.gz: 65e05ba6c678beac4cb3ffe9b343451f18e04b0f
+  data.tar.gz: 15bcb1d1b7512b366a33ba672c0b79ab9cc3161a
 SHA512:
-  metadata.gz: b51f09107487046881c04e942df7bb649471944cc50b99cba5d33209b1689957310671393034e74ca5d210252152bcf2992204eb0a8cdcf68200616211ba2f18
-  data.tar.gz: 0eb990db1e6304d7126c92bd8e6a8759fad4d4eb798a19c53ae75219fa58c0294dc1e60a086dc5f77d6cdde6894fb1e05be563da19d898735815e09d24ff8d71
+  metadata.gz: 5a7094c08403ab00894951527b8652d66d9ac841e95834daab95d1e9ec4fe131aab178b52aa91c8d363789cba98a9c922a88da9108dcf37d55ff8efc4f3b785c
+  data.tar.gz: fc876d2f0ae219d76109e91450e93cef8474ea22ab40f4eeea0a65da1732c86d21f8047e1b718d1c6baf92b089e811b7352250cbc4c838af45b1cc27821865e4

data/CHANGELOG.md

@@ -1,3 +1,7 @@
+## 0.3.0
+
+- PluginManager & media queries.
+
 ## 0.2.0
 
 - Bypass block to `respond_with`.

data/Gemfile

@@ -18,4 +18,6 @@ group :development do
   gem 'rspec-rails', '~> 3.3.3'
 
   gem 'rubocop', '~> 0.33.0'
+
+  gem 'coveralls', '~> 0.8.2', require: false
 end

data/README.md

@@ -47,7 +47,21 @@ Collection of useful modules for Rails.
 - __Forms__
   `hidden_params_fields` to bypass query params in GET-forms.
 
-__[Helpers usage](#helpers)__
+__[Helpers usage](#helpers-usage)__
+
+#### Test helpers:
+
+- __Response__
+  `#json_body` to test json responses.
+
+__[Test helpers usage](#test-helpers-usage)__
+
+#### Assets:
+
+- __MediaQueries__
+  `@media #{$sm-up} and #{$portrait} { ... }` queries for SASS.
+- __[PluginManager](#pluginmanager)__
+  Simple way to create jQuery plugins using classes.
 
 ## Installation
 
@@ -307,7 +321,7 @@ params.require_permitted(:access_token, :refresh_token)
 params.permit(:access_token, :refresh_token).require(:access_token, :refresh_token)
 ```
 
-### Helpers
+### Helpers usage
 
 Include helper module into `ApplicationHelper`.
 Or use `RailsStuff::Helpers::All` to include all helpers together.
@@ -342,6 +356,51 @@ Translation helpers are cached, so there is no need to cache it by yourself in
 template if you want to decrease computations. And be aware of it if you
 switch locales while rendering single view.
 
+### Test helpers usage
+
+Add `require 'rails_stuff/test_helpers/rails'` to `test_helper.rb`.
+
+```ruby
+assert_equal({'id' => 1, 'name' => 'John'}, response.json_body)
+assert_equal('John', response.json_body['name'])
+assert_equal('John', response.json_body.name)
+
+# with rspec-its
+subject { get :show, id: resource.id }
+its(:json_body) { should include 'id' => 1 }
+its('json_body.name') { should eq 'John' }
+```
+
+`.json_body` helper requires `gem 'hashie'`.
+
+Note that `hashie` conflicts with `Hash` methods, so `.json_body.key` or
+`.json_body.hash` will not work as expected (or at all).
+Use `json_body['key']` instead.
+
+### PluginManager
+
+Provides simple way to create jQuery plugins. Create class and PluginManager
+will create jQuery function for it. It'll create instance of class for each
+jQuery element and prevent calling constructor twice.
+
+```coffee
+PluginManager.add 'myPlugin', class
+  constructor: (@$element, @options) ->
+     # ...
+
+  customAction: (options)->
+     # ...
+
+  # Add initializers
+  $ -> $('[data-my-plugin]').myPlugin()
+  # or
+  $(document).on 'click', '[data-my-plugin]', (e) ->
+    $(@).myPlugin('customAction', event: e)
+
+# Or use it manually
+$('.selector').myPlugin().myPlugin('customAction')
+```
+
 ## Development
 
 After checking out the repo, run `bin/setup` to install dependencies.

data/lib/assets/javascripts/rails_stuff/plugin_manager.coffee

@@ -0,0 +1,40 @@
+# Provides simple way to create jQuery plugins. Create class and PluginManager
+# will create jQuery function for it. It'll create instance of class for each
+# jQuery element and prevent calling constructor twice.
+#
+#     PluginManager.add 'myPlugin', class
+#       constructor: (@$element, @options) ->
+#          # ...
+#
+#       customAction: (options)->
+#          # ...
+#
+#       # Add initializers
+#       $ -> $('[data-my-plugin]').myPlugin()
+#       # or
+#       $(document).on 'click', '[data-my-plugin]', (e) ->
+#         $(@).myPlugin('customAction', event: e)
+#
+#     # Or use it manually
+#     $('.selector').myPlugin().myPlugin('customAction')
+class window.PluginManager
+  @plugins = {}
+
+  # Takes class and creates jQuery's plugin function for it.
+  # This function simply creates class instance for each element
+  # and prevents creating multiple instances on single element.
+  #
+  # Name is set explicitly to avoid errors when using uglifier.
+  @add: (pluginName, klass) ->
+    data_index = "#{pluginName}.instance"
+    @plugins[pluginName] = klass
+    jQuery.fn[pluginName] = (action, options) ->
+      if typeof action is 'object'
+        options = action
+        action = null
+      @each ->
+        $this = jQuery @
+        unless instance = $this.data data_index
+          instance = new klass $this, options
+          $this.data data_index, instance
+        instance[action](options) if action

data/lib/assets/stylesheets/rails_stuff/_media_queries.scss

@@ -0,0 +1,25 @@
+// Foundation-style media queries.
+// Works with Bootstrap3 out of the box.
+// Without bootstrap just define variables:
+//   screen-xs-max, screen-{sm,md}-{min,max}, screen-lg-min
+//
+// Usage:
+//
+//   @media #{$sm-up} { ... }
+//   @media #{$sm-only} and #{$landscape} { ... }
+$screen: "only screen" !default;
+
+$landscape: "(orientation: landscape)" !default;
+$portrait: "(orientation: portrait)" !default;
+
+$xs-up: $screen !default;
+$xs-only: "(max-width: #{$screen-xs-max})" !default;
+
+$sm-up: "(min-width:#{$screen-sm-min})" !default;
+$sm-only: "(min-width:#{$screen-sm-min}) and (max-width:#{$screen-sm-max})" !default;
+
+$md-up: "(min-width:#{$screen-md-min})" !default;
+$md-only: "(min-width:#{$screen-md-min}) and (max-width:#{$screen-md-max})" !default;
+
+$lg-up: "(min-width:#{$screen-lg-min})" !default;
+$lg-only: "(min-width:#{$screen-lg-min})" !default;

data/lib/rails_stuff/{railtie.rb → engine.rb}

@@ -49,7 +49,7 @@ module RailsStuff
     end
   end
 
-  class Railtie < Rails::Railtie
+  class Engine < Rails::Engine
     initializer :rails_stuff_setup_modules, after: :load_config_initializers do
       RailsStuff.setup_modules!
     end

data/lib/rails_stuff/version.rb

@@ -5,7 +5,7 @@ module RailsStuff
 
   module VERSION #:nodoc:
     MAJOR = 0
-    MINOR = 2
+    MINOR = 3
     TINY  = 0
     PRE   = nil
 

data/lib/rails_stuff.rb

@@ -16,4 +16,4 @@ module RailsStuff
   autoload :TypesTracker
 end
 
-require 'rails_stuff/railtie' if defined?(Rails::Railtie)
+require 'rails_stuff/engine' if defined?(Rails::Engine)

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rails_stuff
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.3.0
 platform: ruby
 authors:
 - Max Melentiev
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2015-09-15 00:00:00.000000000 Z
+date: 2015-09-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -72,8 +72,11 @@ files:
 - bin/git-hooks/pre-commit
 - bin/install_git_hooks
 - bin/setup
+- lib/assets/javascripts/rails_stuff/plugin_manager.coffee
+- lib/assets/stylesheets/rails_stuff/_media_queries.scss
 - lib/net/http/debug.rb
 - lib/rails_stuff.rb
+- lib/rails_stuff/engine.rb
 - lib/rails_stuff/helpers.rb
 - lib/rails_stuff/helpers/all.rb
 - lib/rails_stuff/helpers/bootstrap.rb
@@ -84,7 +87,6 @@ files:
 - lib/rails_stuff/helpers/translation.rb
 - lib/rails_stuff/nullify_blank_attrs.rb
 - lib/rails_stuff/params_parser.rb
-- lib/rails_stuff/railtie.rb
 - lib/rails_stuff/random_uniq_attr.rb
 - lib/rails_stuff/redis_storage.rb
 - lib/rails_stuff/resources_controller.rb