bootbox_crud 0.1.1.7 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: bf24369f6333a8c7321af19175eed6e5c36ebb75
-  data.tar.gz: 90bbab5b20cc2322cbd1d016668c1a77a0a3c2f6
+  metadata.gz: ccbdc14dcd7da2f93390a0d66070dd0dab61464a
+  data.tar.gz: 9bd017ce47ff303ab88fc40deffb6a3011a6231f
 SHA512:
-  metadata.gz: 8ba3a59b1d598b3b1f2559ce9f3b36c2d49f7092be574cfc1fb523b9b4d259ad37d7192117d042b6f474ed922fedc240638abca86da35493a1287d7faf5d6ca6
-  data.tar.gz: 0cdf0ae1ec61d42566ee805c7bfb4343205471e53c5db01ada2ce00fc3147c9b0cca57dcdd80c052c864a81d2793ffaada9f3e8085d2aa5c0ee2bafe2caddc8b
+  metadata.gz: 7e4a066583e3a4cd8956e7afb3dc69ffe18505912f96d80b6859103ffb35183f132739a24f4fe8992f12890b2e9f58b42bc2b9d8444d211e3536e7fce0eab8b5
+  data.tar.gz: 14e85e099a16b8a9bd7852c4c717e4ed69dd3c7bd0afdaa1a92d3b5f9675127260bfe10e03e8ae6777db56ba4f2ad19f54b92257b86e1d1956f600c0fd93d04d

data/README.md

@@ -5,6 +5,14 @@
 
 Provides Rails modal CRUD scaffolding powered by bootstrap & bootbox & simple_form. Built for use with Turbolinks, jQuery and Twitter Bootstrap 3.
 
+![Screenshots](/screenshots/bbcrud.gif?raw=true "Scaffold example screenshots")
+
+This is what you get after running ```rails g model Block name width:integer height:integer depth:integer``` with this gem setup in your rails application.
+
+All modal views are using AJAX and template partials, which makes it behave faster compared to full page reloads.
+
+Makes it easy to open up a modal for selected action and model on click by [setting](#user-content-links-to-modals) data attributes to HTML tags, no additional javascript needed. 
+
 ## Initial setup
 
 Set custom scaffolding generators in your ```config/application.rb```
@@ -193,24 +201,24 @@ Adding ```class='show'``` to root node with ```id='content'``` is mandatory to g
 Making links modal enabled is done via data attributes.
 
     data-entity='Model'
-    data-action='update'
+    data-action='edit'
     data-id='1'
 
 In haml:
 
-    = link_to '#', :class => 'btn btn-primary btn-sm', data: { id: @model.id, entity: 'Model', action: 'update' } do
+    = link_to '#', :class => 'btn btn-primary btn-sm', data: { id: @model.id, entity: 'Model', action: 'edit' } do
       %i.fa.fa-edit
       edit
 
 There is a global button handler searching for any DOM nodes with 'data-entity' attribute. Click events of such nodes lead to modals.
 The logic is simple, clicking on a node with the above values will lead to this function invocation:
 
-    BBCrud.Model.update({id: 1})
+    BBCrud.Model.edit({id: 1})
 
 Available actions are:
 
- * create
- * update
+ * new
+ * edit
  * show
 
 #### Adding a new model to modals on the client side
@@ -229,9 +237,9 @@ Filled in for unipolars:
 
 The above function invocation creates these functions:
 
-    BBCrud.Unipolar.create
-    BBCrud.Unipolar.update
-    BBCrud.Unipolar.show
+    BBCrud.Models.Unipolar.new
+    BBCrud.Models.Unipolar.edit
+    BBCrud.Models.Unipolar.show
 
 Now you should be all set to click your data-entity links and call the functions from your scripts if needed.
 
@@ -266,7 +274,7 @@ The important detail to notice is the use of ```modals/form``` partial, which wa
  * Make sure your form has ```remote: true``` or preferably ```remote_form_options``` with simple\_form, the layout should be the same as in the example in form section of this README
  * Add create, update and destroy .js.erb files to the view directory and fill them according to this guide
  * Add your model definition as a new line to models.js
- * Add ```data-entity```, ```data-action``` and ```data-id``` with the right values to an element on the page and click it, or call ``BBCrud.ModelName.create/update/show()`` from your javascript to show the modal
+ * Add ```data-entity```, ```data-action``` and ```data-id``` with the right values to an element on the page and click it, or call ``BBCrud.Models.ModelName.new/edit/show()`` from your javascript to show the modal
 
 
 ## Custom scaffold source files
@@ -297,6 +305,13 @@ If you want have a peek or override some of the scaffolding templates, here is a
 
     lib/templates/rails/scaffold_controller/controller.rb
 
+# Changelog
+ **0.2.0** - some breaking changes
+ 
+  * defined model actions moved to BBCrud.Models.<ModelName>, declaring them directly on  BBCrud.<ModelName> was dangerous, new models could overwrite basic functionality [Models, Modals, Alert] 
+  * renamed actions on models to new, edit, show [previously was create, update, show]
+  * added a few more jasmine specs
+
 # TODOs
 
  * I18n support on client side

data/lib/bootbox_crud/version.rb

@@ -1,5 +1,5 @@
 module BootboxCrud
   module Rails
-    VERSION = '0.1.1.7'
+    VERSION = '0.2.0'
   end
 end

data/lib/templates/haml/scaffold/index.html.haml

@@ -40,12 +40,12 @@
             %td= <%= singular_table_name %>.<%= attribute.name %>
 <% end -%>
             %td
-              = link_to '#', :class => 'btn-sm btn-primary', data: { entity: '<%= class_name %>', action: 'update', id: (<%= singular_table_name %>.id) } do
+              = link_to '#', :class => 'btn-sm btn-primary', data: { entity: '<%= class_name %>', action: 'edit', id: (<%= singular_table_name %>.id) } do
                 %i.fa.fa-edit
                 EDIT
 
   %hr
   %p
-    = link_to '#', :class => 'btn btn-success', data: { entity: '<%= class_name %>', action: 'create' } do
+    = link_to '#', :class => 'btn btn-success', data: { entity: '<%= class_name %>', action: 'new' } do
       %i.fa.fa-plus
         = 'New <%= human_name %>'

data/test/dummy/app/views/blocks/index.html.haml

@@ -27,12 +27,12 @@
             %td= block.height
             %td= block.depth
             %td
-              = link_to '#', :class => 'btn-sm btn-primary', data: { entity: 'Block', action: 'update', id: (block.id) } do
+              = link_to '#', :class => 'btn-sm btn-primary', data: { entity: 'Block', action: 'edit', id: (block.id) } do
                 %i.fa.fa-edit
                 EDIT
 
   %hr
   %p
-    = link_to '#', :class => 'btn btn-success', data: { entity: 'Block', action: 'create' } do
+    = link_to '#', :class => 'btn btn-success', data: { entity: 'Block', action: 'new' } do
       %i.fa.fa-plus
         = 'New Block'

data/test/dummy/spec/javascripts/alert_spec.js.es6

@@ -1,5 +1,8 @@
 describe("BBCrud.Alert", () => {
   it("BBCrud.Alert is defined", () => {
     expect(BBCrud.Alert).toBeDefined();
+    expect(BBCrud.Alert.init).toBeDefined();
+    expect(BBCrud.Alert.show).toBeDefined();
+    expect(BBCrud.Alert.hide).toBeDefined();
   });
 });

data/test/dummy/spec/javascripts/modals_spec.js.es6

@@ -1,5 +1,12 @@
 describe("BBCrud.Modals", () => {
   it("BBCrud.Modals is defined", () => {
     expect(BBCrud.Modals).toBeDefined();
+    expect(BBCrud.Modals.create).toBeDefined();
+    expect(BBCrud.Modals.update).toBeDefined();
+    expect(BBCrud.Modals.show).toBeDefined();
+    expect(BBCrud.Modals.delete).toBeDefined();
+    expect(BBCrud.Modals.form).toBeDefined();
+    expect(BBCrud.Modals.other).toBeDefined();
+    expect(BBCrud.Modals.initBtnHandler).toBeDefined();
   });
 });

data/test/dummy/spec/javascripts/models_spec.js.es6

@@ -1,5 +1,25 @@
 describe("BBCrud.Models", () => {
   it("BBCrud.Models is defined", () => {
     expect(BBCrud.Models).toBeDefined();
+    expect(BBCrud.Models.add).toBeDefined();
+    expect(BBCrud.Models.addAction).toBeDefined();
+  });
+});
+
+describe("BBCrud.Models.add", () => {
+  it("Creates new model object on BBCrud.Models", () => {
+    BBCrud.Models.add('Box', '/boxes/', 'box');
+    expect(BBCrud.Models.Box).toBeDefined();
+    expect(BBCrud.Models.Box.create).toBeDefined();
+    expect(BBCrud.Models.Box.update).toBeDefined();
+    expect(BBCrud.Models.Box.show).toBeDefined();
+  });
+});
+
+describe("BBCrud.Models.addAction", () => {
+  it("Creates a new model, if it wasn't previously defined and adds a function to it", () => {
+    BBCrud.Models.addAction('Sphere', '/spheres/', 'sphere', 'tessellate');
+    expect(BBCrud.Models.Sphere).toBeDefined();
+    expect(BBCrud.Models.Sphere.tessellate).toBeDefined();
   });
 });

data/vendor/assets/javascripts/bootbox_crud_modals.js

@@ -149,7 +149,7 @@ BBCrud.Modals = (function () {
                 var args = $.extend({}, link.data());
                 delete args['entity'];
                 delete args['action'];
-                BBCrud[link.data('entity')][link.data('action')].call(link, args);
+                BBCrud.Models[link.data('entity')][link.data('action')].call(link, args);
                 return false;
             });
         }
@@ -161,10 +161,10 @@ BBCrud.Modals.initBtnHandler();
 
 BBCrud.Models = (function () {
     function defineModelActions(modelName, actions) {
-        if (typeof BBCrud[modelName] === 'undefined') {
-            BBCrud[modelName] = actions;
+        if (typeof BBCrud.Models[modelName] === 'undefined') {
+            BBCrud.Models[modelName] = actions;
         } else {
-            $.extend(BBCrud[modelName], actions);
+            $.extend(BBCrud.Models[modelName], actions);
         }
     }
 
@@ -174,10 +174,10 @@ BBCrud.Models = (function () {
                 var baseUrl = url;
 
                 return {
-                    create: function (data) {
+                    new: function (data) {
                         BBCrud.Modals.create('Create ' + titleName, baseUrl, null, data);
                     },
-                    update: function (data) {
+                    edit: function (data) {
                         BBCrud.Modals.update(data.id, 'Edit ' + titleName, baseUrl, undefined, false, undefined, undefined, data);
                     },
                     show: function (data) {
@@ -200,7 +200,6 @@ BBCrud.Models = (function () {
             }());
             defineModelActions(modelName, action);
         }
-
     };
 }());
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: bootbox_crud
 version: !ruby/object:Gem::Version
-  version: 0.1.1.7
+  version: 0.2.0
 platform: ruby
 authors:
 - Jiri Kaipr
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-03-29 00:00:00.000000000 Z
+date: 2016-03-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: railties
@@ -256,6 +256,7 @@ files:
 - lib/templates/haml/scaffold/new.html.haml
 - lib/templates/haml/scaffold/show.html.haml
 - lib/templates/rails/scaffold_controller/controller.rb
+- screenshots/bbcrud.gif
 - test/dummy/README.rdoc
 - test/dummy/Rakefile
 - test/dummy/app/assets/images/.keep