oxymoron 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 6bab8fc9df619ce47e56b79c782fe4dd66b8e9c3
+  data.tar.gz: e3ecc62002de472434a45b3b3842c92fa3c2d580
+SHA512:
+  metadata.gz: 4e08c72c3407a4ce304fc6c862ffde67b6f81be3c33be6db753df4bde486f3caf32acc52db4d6b7b11bdc6f44e36823967b5b7cc28d16178a90af39b0f264f54
+  data.tar.gz: 392bd474869d94851ec8db6a6ddb516f2c538599c78df5a6f806cbde42333ab1a0f246f9b06511bb52ea17d2cc281df5e55fd50621c50d05b104db7ac3cdaf99

data/.gitignore

@@ -0,0 +1,10 @@
+*.gem
+.bundle
+Gemfile.lock
+gemfiles/*.lock
+pkg/*
+bin
+vendor/ruby
+gemfiles/vendor/ruby
+.rbenv-version
+.sass-cache

data/Gemfile

@@ -0,0 +1,13 @@
+source 'https://rubygems.org'
+
+# Declare your gem's dependencies in oxymoron.gemspec.
+# Bundler will treat runtime dependencies like base dependencies, and
+# development dependencies will be added by default to the :development group.
+gemspec
+
+# Declare any dependencies that are still in development here instead of in
+# your gemspec. These might include edge Rails or gems from your path or
+# Git. Remember to move these dependencies to your gemspec before releasing
+# your gem to rubygems.org.
+
+# To use a debugger 

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2015 Павел Кононенко
+
+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.RU.md

@@ -0,0 +1,324 @@
+# Oxymoron
+
+##Установка
+
+Добавьте гем в Gemfile:
+
+```
+gem "oxymoron", git: "https://github.com/storuky/oxymoron.git", branch: :master
+```
+
+## Первичные настройки (Asset Pipeline)
+
+Подключите зависимости внутри application.js и application.css
+
+**application.js**
+```
+/*
+= require oxymoron/angular
+= require oxymoron/angular-resource
+= require oxymoron/angular-cookies
+= require oxymoron/angular-ui-router
+= require oxymoron/ng-notify
+= require oxymoron
+*/
+```
+
+**application.css**
+```
+/*
+ *= require oxymoron/ng-notify
+ */
+```
+
+##Использование
+
+Далее необходимо заинжектить 'oxymoron' и 'ui.router' в ваше AngularJS-приложение
+
+**application.js**
+```
+angular.module('app', ['ui.router', 'oxymoron'])
+```
+
+Создайте файл routes.js, который будет содержать роуты приложение. Метод $stateProvider.rails() дублирует роутинг рельсового routes.rb.
+
+**routes.js**
+```
+angular.module('app')
+  .config(['$stateProvider', function ($stateProvider) {
+    $stateProvider.rails()
+  }])
+```
+
+В applicaiton_controller.rb необходимо выключать лейаут, если была запрошена страница посредством ajax-запроса.
+
+**app/controllers/application_controller.rb**
+```
+class ApplicationController < ActionController::Base
+  layout proc {
+    if request.xhr?
+      false
+    else
+      index
+      'application' # или другой лейаут
+    end
+  }
+  
+  private
+  def index
+    # В продуктовом режиме следует прописать эту строчку в initializers/oxymoron.rb
+    ActionView::Base.default_form_builder = OxymoronBuilder
+  end
+end
+```
+
+Отредактируйте ваш лейаут, изменив
+
+**app/views/layouts/application**
+```
+= yield
+```
+на
+```
+ui-view
+```
+или для СЕО-френдли на
+```
+ui-view
+  div[ng-non-bindable]
+    = yield
+```
+
+
+Все методы CRUD должны быть обернуты внутрь respond_to
+
+**Example:**
+```
+class PostsController < ActiveRecord::Base
+  before_action :set_post, only: [:show, :update, :destroy]
+
+  def index
+    respond_to do |format|
+      format.html
+      format.json {
+        @posts = Post.all
+        render json: @posts
+      }
+    end
+  end
+  
+  def show
+    respond_to do |format|
+      format.html
+      format.json {
+        render json: @post
+      }
+    end
+  end
+  
+  def new
+  end
+  
+  def edit
+  end
+  
+  def create
+    respond_to do |format|
+      format.json {
+        @post = Post.new post_params
+        if @post.save
+          render json: {post: @post, msg: "Post successfully created", redirect_to: "posts_path"}
+        else
+          render json: {errors: @post.errors, msg: @post.errors.full_messages.join(', ')}, status: 422
+        end
+      }
+    end
+  end
+
+  def update
+    respond_to do |format|
+      format.json {
+        if @post.update(post_params)
+          render json: {post: @post, msg: "Post successfully updated", redirect_to: "posts_path"}
+        else
+          render json: {errors: @post.errors, msg: @post.errors.full_messages.join(', ')}, status: 422
+        end
+      }
+    end
+  end
+
+  def destroy
+    respond_to do |format|
+      format.json {
+        @post.destroy
+        render json: {msg: "Post successfully deleted"}
+      }
+    end
+  end
+  
+  private
+    def set_post
+      @post = Post.find(params[:id])
+    end
+    
+    def post_params
+      params.require(:post).permit(:title, :description, :author)
+    end
+end
+```
+
+Oxymoron добавляет некоторую функциональность для вашего AngularJS-приложения. В частности, нам становятся доступны фабрики-ресурсы имя которых соответствует имени вашей модели в Rails-приложении. В нашем случае это фабрика Post.
+
+**Доступны следующие методы для работы с ресурсами:**
+```
+Post.query() // => GET /posts.json
+Post.get({id: id}) // => GET /posts/:id.json
+Post.new() // => GET /posts/new.json
+Post.edit({id: id}) // => GET /posts/:id/edit.json
+Post.create({post: post}) // => POST /posts.json
+Post.update({id: id, post: post}) // => PUT /posts/:id.json
+Post.destroy({id: id}) // => DELETE /posts/:id.json
+```
+
+Создайте AngularJS-контроллер "PostsCtrl"
+
+**Пример:**
+
+```
+angular.module('app')
+  .controller('PostsCtrl', ['Post', 'action', function (Post, action) {
+    var ctrl = this;
+    
+    // Данный код вызовется только на странице '/posts'
+    action('index', function(){
+      ctrl.posts = Post.query();
+    });
+    
+    // Вызовется на страницах соответсующих паттерну '/posts/:id'
+    action('show', function (params){
+      ctrl.post = Post.get({id: params.id});
+    });
+    
+    // Вызовется на '/posts/new'
+    action('new', function(){
+      ctrl.post = Post.new();
+      ctrl.save = Post.create;
+    });
+    
+    // Вызовется на '/posts/:id/edit'
+    action('edit', function (params){
+      ctrl.post = Post.edit({id: params.id});
+      ctrl.save = Post.update;
+    })
+    
+    // Вызовется на двух страницах
+    action(['edit', 'new'], function(){
+      //
+    })
+    
+    // Вызовется на '/posts/some_method'
+    action('some_method', function(){
+      //
+    })
+    
+    // etc
+  }])
+```
+
+##Пример Views
+**posts/index.html.slim**
+
+```
+h1 Posts
+
+input type="text" ng-model="search"
+
+table
+  thead
+    tr
+      th Date
+      th Title
+      th Author
+  tbody
+    tr ng-repeat="post in ctrl.posts | filter:search"
+      td
+        | {{post.created_at | date:"dd.MM.yyyy"}}
+      td
+        | {{post.title}}
+      td
+        | {{post.author}}
+```
+
+**posts/show.html.slim**
+```
+dl
+  dl Date
+  dd
+    | {{ctrl.post.created_at | date:"dd.MM.yyyy"}}
+  dl Title
+  dd
+    | {{ctrl.post.title}}
+  dl author
+  dd
+    | {{ctrl.post.author}}
+```
+
+**posts/new.html.slim**
+```
+h1 New post
+
+= render 'form'
+```
+
+**posts/edit.html.slim**
+```
+h1 Edit post
+
+= render 'form'
+```
+
+**posts/_form.html.slim**
+```
+= form_for Post.new do |f|
+  div
+    = f.label :title
+    = f.text_field :title
+  div
+    = f.label :description
+    = f.text_area :description
+  
+  = f.submit "Save"
+  
+```
+
+Для задания ссылок используйте аттрибут ui-sref, как это описано в документации
+```
+a ui-sref="posts_path" Все посты
+a ui-sref="new_post_path" Новый пост
+a ui-sref="edit_post_path({id: id})" Редактировать пост
+a ui-sref="post_path({id: id})" Просмотр поста
+```
+
+##Дополнительно
+В window вам доступна переменная Routes, в которой хранятся все роуты приложения.
+
+**Например**
+```
+Routes.posts_path() //=> '/posts'
+Routes.post_path({id: 1}) //=> '/posts/1'
+Routes.post_path({id: 1, format: "json"}) //=> '/posts/1.json'
+Routes.posts_url() //=> 'http://localhost:3000/posts'
+```
+Старайтесть избегать использование Routes для составления ajax-запросов на методы ресурсов.
+
+Если ожидается, что ваш метод, определенный на ресурсе возвращает массив, то необходимо сделать соответстующую пометку
+
+```
+resources :posts do
+  get 'my', is_array: true
+end
+```
+
+Тогда выполнив метод Post.my() внутри вашего AngularJS-контроллера, вы получите данные в виде массива. В противном случае, AngularJS выкинет исключение.
+
+Приятного кодинга:)

data/README.md

@@ -0,0 +1,319 @@
+# Oxymoron
+
+##Setup
+
+Add it to your Gemfile:
+
+```
+gem "oxymoron", git: "https://github.com/storuky/oxymoron.git", branch: :master
+```
+
+## Basic settings (Asset Pipeline)
+
+Add dependencies to your application.js and application.css
+
+**application.js**
+```
+/*
+= require oxymoron/angular
+= require oxymoron/angular-resource
+= require oxymoron/angular-cookies
+= require oxymoron/angular-ui-router
+= require oxymoron/ng-notify
+= require oxymoron
+*/
+```
+
+**application.css**
+```
+/*
+ *= require oxymoron/ng-notify
+ */
+```
+
+##Usage
+
+Next, you need to inject required modules 'oxymoron' and 'ui.router'
+
+**application.js**
+```
+angular.module('app', ['ui.router', 'oxymoron'])
+```
+
+Create file routes.js, which will contain the application SPA-routings. Method $stateProvider.rails() transform routes.rb to Angular UI Router states.
+
+**routes.js**
+```
+angular.module('app')
+  .config(['$stateProvider', function ($stateProvider) {
+    $stateProvider.rails()
+  }])
+```
+
+Disable layouts for all ajax query:
+
+**app/controllers/application_controller.rb**
+```
+class ApplicationController < ActionController::Base
+  layout proc {
+    if request.xhr?
+      false
+    else
+      index
+      'application' # или другой лейаут
+    end
+  }
+  
+  private
+  def index
+    # In the production mode write this string into initializers/oxymoron.rb
+    ActionView::Base.default_form_builder = OxymoronBuilder
+  end
+end
+```
+
+Edit your layout with ui-view notation:
+
+**app/views/layouts/application**
+```
+= yield
+```
+to
+```
+ui-view
+```
+or for SEO-friendly
+```
+ui-view
+  div[ng-non-bindable]
+    = yield
+```
+
+
+All controllers methods must be wrapped with respond_to
+
+**Example:**
+```
+class PostsController < ActiveRecord::Base
+  before_action :set_post, only: [:show, :update, :destroy]
+
+  def index
+    respond_to do |format|
+      format.html
+      format.json {
+        @posts = Post.all
+        render json: @posts
+      }
+    end
+  end
+  
+  def show
+    respond_to do |format|
+      format.html
+      format.json {
+        render json: @post
+      }
+    end
+  end
+  
+  def new
+  end
+  
+  def edit
+  end
+  
+  def create
+    respond_to do |format|
+      format.json {
+        @post = Post.new post_params
+        if @post.save
+          render json: {post: @post, msg: "Post successfully created", redirect_to: "posts_path"}
+        else
+          render json: {errors: @post.errors, msg: @post.errors.full_messages.join(', ')}, status: 422
+        end
+      }
+    end
+  end
+
+  def update
+    respond_to do |format|
+      format.json {
+        if @post.update(post_params)
+          render json: {post: @post, msg: "Post successfully updated", redirect_to: "posts_path"}
+        else
+          render json: {errors: @post.errors, msg: @post.errors.full_messages.join(', ')}, status: 422
+        end
+      }
+    end
+  end
+
+  def destroy
+    respond_to do |format|
+      format.json {
+        @post.destroy
+        render json: {msg: "Post successfully deleted"}
+      }
+    end
+  end
+  
+  private
+    def set_post
+      @post = Post.find(params[:id])
+    end
+    
+    def post_params
+      params.require(:post).permit(:title, :description, :author)
+    end
+end
+```
+
+Oxymoron add some functionality for your AngularJS application. You can use *factory* whose name matches the name of your resources routes.rb. Do not forget to inject it, when it's required.
+In our case it is Post resource.
+
+```
+Post.query() // => GET /posts.json
+Post.get({id: id}) // => GET /posts/:id.json
+Post.new() // => GET /posts/new.json
+Post.edit({id: id}) // => GET /posts/:id/edit.json
+Post.create({post: post}) // => POST /posts.json
+Post.update({id: id, post: post}) // => PUT /posts/:id.json
+Post.destroy({id: id}) // => DELETE /posts/:id.json
+```
+
+Add AngularJS-controller "PostsCtrl"
+
+**Example:**
+
+```
+angular.module('app')
+  .controller('PostsCtrl', ['Post', 'action', function (Post, action) {
+    var ctrl = this;
+    
+    // Called only on '/posts'
+    action('index', function(){
+      ctrl.posts = Post.query();
+    });
+    
+    // Called only for '/posts/:id'
+    action('show', function (params){
+      ctrl.post = Post.get({id: params.id});
+    });
+    
+    // Called only on '/posts/new'
+    action('new', function(){
+      ctrl.post = Post.new();
+      ctrl.save = Post.create;
+    });
+    
+    // Called only for '/posts/:id/edit'
+    action('edit', function (params){
+      ctrl.post = Post.edit({id: params.id});
+      ctrl.save = Post.update;
+    })
+    
+    // Called only for '/posts/:id/edit' or '/posts/new'
+    action(['edit', 'new'], function(){
+      //
+    })
+    
+    // Called only for your custom resource method. For example: '/posts/some_method'
+    action('some_method', function(){
+      //
+    })
+    
+    // etc
+  }])
+```
+
+##Example Views
+**posts/index.html.slim**
+
+```
+h1 Posts
+
+input type="text" ng-model="search"
+
+table
+  thead
+    tr
+      th Date
+      th Title
+      th Author
+  tbody
+    tr ng-repeat="post in ctrl.posts | filter:search"
+      td
+        | {{post.created_at | date:"dd.MM.yyyy"}}
+      td
+        | {{post.title}}
+      td
+        | {{post.author}}
+```
+
+**posts/show.html.slim**
+```
+dl
+  dl Date
+  dd
+    | {{ctrl.post.created_at | date:"dd.MM.yyyy"}}
+  dl Title
+  dd
+    | {{ctrl.post.title}}
+  dl author
+  dd
+    | {{ctrl.post.author}}
+```
+
+**posts/new.html.slim**
+```
+h1 New post
+
+= render 'form'
+```
+
+**posts/edit.html.slim**
+```
+h1 Edit post
+
+= render 'form'
+```
+
+**posts/_form.html.slim**
+```
+= form_for Post.new do |f|
+  div
+    = f.label :title
+    = f.text_field :title
+  div
+    = f.label :description
+    = f.text_area :description
+  
+  = f.submit "Save"
+  
+```
+
+Use *ui-sref* insted of link_to helper
+```
+a ui-sref="posts_path" All posts
+a ui-sref="new_post_path" New post
+a ui-sref="edit_post_path({id: id})" Edit post
+a ui-sref="post_path({id: id})" Show
+```
+
+##Routes
+In window you can find *Routes* variable, which contains all routes of your app (such as JsRoutes).
+
+**Example**
+```
+Routes.posts_path() //=> '/posts'
+Routes.post_path({id: 1}) //=> '/posts/1'
+Routes.post_path({id: 1, format: "json"}) //=> '/posts/1.json'
+Routes.posts_url() //=> 'http://localhost:3000/posts'
+```
+If your expect that your controller method return an array, you must mark this routes with *is_array* property. If you do not, it throw an exception from angular.
+```
+resources :posts do
+  get 'my', is_array: true
+end
+```
+
+Happy coding :)