greenin 1.0.1 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 741c1937512012abe2964fddcf304fd44d0ba585
-  data.tar.gz: a71adc705bcb5b867b79f0d85599b3576d7eaec6
+  metadata.gz: 2033e9cdfa4ed544139dc352a45fdda77afba6af
+  data.tar.gz: 4dcd42334e6957f04ecec0e8567dc2a5e9c93484
 SHA512:
-  metadata.gz: 4d553d4d337d0c21b772de0162060bcdc0411a416f42ded668318719edb7da7a4b79ea1242c0f17fa58a37f091578d76773c6a818962be5c51f8a565b649896a
-  data.tar.gz: 0536be393b5ff9b634b24c2f92481b9ff97f636d4516630872584acae40b62a9533f54b1a1d4f8f9244a5eec566d1a518d341b0f1cfcfb8eeee97aca6b82cc19
+  metadata.gz: 05afeec084aff3a535804d795c9c0a300c08a7a9c183b3a3a9738dd0247774835d06da58f396ec2458deef939112c46c3d40f15e5d46216d6a4a5f6fd9f27f86
+  data.tar.gz: ff27306b5c8a98516660cc72030f53d53a21c132ab13ba3c2a03774bfd7202200d36e6911e9d813f4899fc313aee02c0f4c0456c9eea49c6d00991364ec2dc2a

data/.gitignore

@@ -12,3 +12,4 @@
 *.o
 *.a
 mkmf.log
+/spec/dummy/log/test.log

data/.rspec

@@ -0,0 +1,3 @@
+--color
+--format documentation
+--require rails_helper

data/.travis.yml

@@ -0,0 +1,11 @@
+language: ruby
+rvm:
+  - 2.0
+  - 2.1
+  - 2.2
+  - ruby-head
+bundler_args: --without production
+addons:
+  code_climate:
+    repo_token: 6a19929ed0a99137c10684ba06ca240aa176173a4ff878248db3ec5f7aecf726
+script: bundle exec rspec spec

data/Gemfile

@@ -1,4 +1,8 @@
 source 'https://rubygems.org'
 
 # Specify your gem's dependencies in greenin.gemspec
+
+gem "codeclimate-test-reporter", group: :test, require: nil
+
 gemspec
+

data/README.md

@@ -1,5 +1,9 @@
 # Greenin
+[![Gem Version](https://badge.fury.io/rb/greenin.svg)](http://badge.fury.io/rb/greenin)
+[![Build Status](https://travis-ci.org/itbeaver/greenin.svg?branch=develop)](https://travis-ci.org/itbeaver/greenin)
 [![Code Climate](https://codeclimate.com/github/itbeaver/greenin/badges/gpa.svg)](https://codeclimate.com/github/itbeaver/greenin)
+[![Test Coverage](https://codeclimate.com/github/itbeaver/greenin/badges/coverage.svg)](https://codeclimate.com/github/itbeaver/greenin)
+[![Dependency Status](https://gemnasium.com/itbeaver/greenin.svg)](https://gemnasium.com/itbeaver/greenin)
 
 Describe your Grape Entities in Rails Active Record models
 
@@ -57,21 +61,38 @@ class Post < ActiveRecord::Base
 end
 ```
 
-So, now you can call entity like that:
+This gem add methods to your ActiveRecord models that call Entity.represent(self, args), so, you can call entity like that:
 ```ruby
-Post::Entity
-# => Post::Entity
-
-Post.entity
-# => Post::Entity
+Post::Entity == Post.entity
+# => true
 
 Post.all.entity
-# => #<Post::Entity:0x007fb4610d8a00
-#    @object=#<ActiveRecord::Relation [...]>, @options={}>
+# => {"posts"=>[#<Post::Entity:0x007ff0880d7d18
+#                @object=#<Post id: 1, title: "Some title", created_at: "2015-02-27 17:48:07",
+#                         updated_at: "2015-02-27 17:48:07">, @options={:collection=>true}>, ...]}
+
+Post.all.entity.to_json
+# => {"posts":[{"title":"Some title"},{"title":"Some title"},{"title":"Some title"}]}
+
+Post.all.entity(root: 'myposts').to_json
+# => {"myposts":[{"title":"Some title"},{"title":"Some title"},{"title":"Some title"}]}
+
+Post.all.entity(root: 'myposts').to_json == Post::Entity.represent(Post.all, root: 'myposts').to_json
+# => true
+
+Post.first.entity.to_json
+# => {"post":[{"title":"Some title"}]}
 
-Post.first.entity
-# => #<Post::Entity:0x007fb462263090 @object=
-#    #<Post id: nil, ..., created_at: nil, updated_at: nil>, @options={}>
+Post.first.entity(root: false).to_json
+# => {"title":"Some title"}
+```
+
+In grape controller using json formatter:
+```ruby
+  get '/posts' do
+    status 200
+    present Post.all.entity
+  end
 ```
 
 ## Contributing

data/greenin.gemspec

@@ -9,7 +9,8 @@ Gem::Specification.new do |spec|
   spec.authors       = ['Russkikh Artem']
   spec.email         = ['russkikhartem@itbeaver.co']
   spec.summary       = 'Grape Entities in Rails models'
-  spec.description   = 'Describe your Grape Entities in Rails Active Record models'
+  spec.description   = 'Describe your Grape Entities
+                        in Rails Active Record models'
   spec.homepage      = 'http://itbeaver.co'
   spec.license       = 'MIT'
 
@@ -18,6 +19,17 @@ Gem::Specification.new do |spec|
   spec.test_files    = spec.files.grep(/^(test|spec|features)\//)
   spec.require_paths = ['lib']
 
-  spec.add_development_dependency 'bundler', '~> 1.7'
+  spec.add_runtime_dependency 'activerecord', '>= 0'
+  spec.add_runtime_dependency 'railties', '>= 0'
+
+  spec.add_development_dependency 'grape', '~> 0.11.0'
+  spec.add_development_dependency 'grape-entity', '~> 0.4.4'
+  spec.add_development_dependency 'rspec-rails', '~> 3.2.0'
+  spec.add_development_dependency 'factory_girl_rails', '~> 4.5.0'
+  spec.add_development_dependency 'database_cleaner', '~> 1.4.0'
+  spec.add_development_dependency 'sqlite3', '~> 1.3.10'
+
+  spec.add_development_dependency 'byebug', '>= 0'
+  spec.add_development_dependency 'bundler', '>= 1.6'
   spec.add_development_dependency 'rake', '~> 10.0'
 end

data/lib/active_record_overrides.rb

@@ -3,17 +3,27 @@ module ActiveRecord
   #
   # Examples
   #
-  #   User.all.entity
-  #   # => #<User::Entity:0x007fb4610d8a00
-  #        @object=#<ActiveRecord::Relation [...]>, @options={}>
+  #   User.all.entity(root: 'users').to_json
+  #   # => { "users":
+  #           [{
+  #               "title": "Some title"
+  #             },
+  #             {
+  #              "title": "Some title"
+  #             },
+  #             {
+  #              "title": "Some title"
+  #             }]
+  #         }
+
   class Relation
-    define_method(Greenin.entity_method_name) do
+    define_method(Greenin.entity_method_name) do |args={}|
       begin
         entity = %(#{model}::#{Greenin.entity_class_name}).constantize
       rescue NameError
         entity = nil
       end
-      entity.new(self) if entity
+      entity.represent(self, args) if entity
     end
   end
 
@@ -24,9 +34,8 @@ module ActiveRecord
   #   User.entity
   #   # => User::Entity
   #
-  #   User.new.entity
-  #   # => #<User::Entity:0x007fb462263090 @object=
-  #        #<User id: nil, ..., created_at: nil, updated_at: nil>, @options={}>
+  #   User.first.entity(root: false).to_json
+  #   # => {"title":"Some title"}
   class Base
     define_singleton_method Greenin.entity_method_name do
       begin
@@ -37,14 +46,14 @@ module ActiveRecord
       entity
     end
 
-    define_method(Greenin.entity_method_name) do
+    define_method(Greenin.entity_method_name) do |args={}|
       begin
         entity = %(#{self.class}::#{Greenin.entity_class_name})
                  .constantize
       rescue NameError
         entity = nil
       end
-      entity.new(self) if entity
+      entity.represent(self, args) if entity
     end
   end
 end

data/lib/greenin/version.rb

@@ -1,3 +1,3 @@
 module Greenin
-  VERSION = '1.0.1'
+  VERSION = '1.1.0'
 end

data/spec/dummy/README.rdoc

@@ -0,0 +1,28 @@
+== README
+
+This README would normally document whatever steps are necessary to get the
+application up and running.
+
+Things you may want to cover:
+
+* Ruby version
+
+* System dependencies
+
+* Configuration
+
+* Database creation
+
+* Database initialization
+
+* How to run the test suite
+
+* Services (job queues, cache servers, search engines, etc.)
+
+* Deployment instructions
+
+* ...
+
+
+Please feel free to use a different markup language if you do not plan to run
+<tt>rake doc:app</tt>.

data/spec/dummy/Rakefile

@@ -0,0 +1,6 @@
+# Add your own tasks in files placed in lib/tasks ending in .rake,
+# for example lib/tasks/capistrano.rake, and they will automatically be available to Rake.
+
+require File.expand_path('../config/application', __FILE__)
+
+Rails.application.load_tasks

data/spec/dummy/app/api/base_api.rb

@@ -0,0 +1,10 @@
+class BaseApi < Grape::API
+  def self.inherited(subclass)
+    super
+    subclass.instance_eval do
+      version 'v1', using: :header, vendor: 'dummy', cascade: false
+      format :json
+      default_format :json
+    end
+  end
+end

data/spec/dummy/app/api/dummy_api.rb

@@ -0,0 +1,2 @@
+class DummyApi < BaseApi
+end

data/spec/dummy/app/assets/javascripts/application.js

@@ -0,0 +1,13 @@
+// This is a manifest file that'll be compiled into application.js, which will include all the files
+// listed below.
+//
+// Any JavaScript/Coffee file within this directory, lib/assets/javascripts, vendor/assets/javascripts,
+// or any plugin's vendor/assets/javascripts directory can be referenced here using a relative path.
+//
+// It's not advisable to add code directly here, but if you do, it'll appear at the bottom of the
+// compiled file.
+//
+// Read Sprockets README (https://github.com/sstephenson/sprockets#sprockets-directives) for details
+// about supported directives.
+//
+//= require_tree .

data/spec/dummy/app/assets/stylesheets/application.css

@@ -0,0 +1,15 @@
+/*
+ * This is a manifest file that'll be compiled into application.css, which will include all the files
+ * listed below.
+ *
+ * Any CSS and SCSS file within this directory, lib/assets/stylesheets, vendor/assets/stylesheets,
+ * or any plugin's vendor/assets/stylesheets directory can be referenced here using a relative path.
+ *
+ * You're free to add application-wide styles to this file and they'll appear at the bottom of the
+ * compiled file so the styles you add here take precedence over styles defined in any styles
+ * defined in the other CSS/SCSS files in this directory. It is generally better to create a new
+ * file per style scope.
+ *
+ *= require_tree .
+ *= require_self
+ */

data/spec/dummy/app/controllers/application_controller.rb

@@ -0,0 +1,5 @@
+class ApplicationController < ActionController::Base
+  # Prevent CSRF attacks by raising an exception.
+  # For APIs, you may want to use :null_session instead.
+  protect_from_forgery with: :exception
+end

data/spec/dummy/app/helpers/application_helper.rb

@@ -0,0 +1,2 @@
+module ApplicationHelper
+end

data/spec/dummy/app/models/post.rb

@@ -0,0 +1,6 @@
+class Post < ActiveRecord::Base
+  class Entity < Grape::Entity
+    root 'posts', 'post'
+    expose :title, documentation: { type: 'String', desc: 'Post title' }
+  end
+end

data/spec/dummy/app/views/layouts/application.html.erb

@@ -0,0 +1,14 @@
+<!DOCTYPE html>
+<html>
+<head>
+  <title>Dummy</title>
+  <%= stylesheet_link_tag    'application', media: 'all', 'data-turbolinks-track' => true %>
+  <%= javascript_include_tag 'application', 'data-turbolinks-track' => true %>
+  <%= csrf_meta_tags %>
+</head>
+<body>
+
+<%= yield %>
+
+</body>
+</html>

data/spec/dummy/bin/bundle

@@ -0,0 +1,3 @@
+#!/usr/bin/env ruby
+ENV['BUNDLE_GEMFILE'] ||= File.expand_path('../../Gemfile', __FILE__)
+load Gem.bin_path('bundler', 'bundle')

data/spec/dummy/bin/rails

@@ -0,0 +1,4 @@
+#!/usr/bin/env ruby
+APP_PATH = File.expand_path('../../config/application', __FILE__)
+require_relative '../config/boot'
+require 'rails/commands'

data/spec/dummy/bin/rake

@@ -0,0 +1,4 @@
+#!/usr/bin/env ruby
+require_relative '../config/boot'
+require 'rake'
+Rake.application.run

data/spec/dummy/bin/setup

@@ -0,0 +1,29 @@
+#!/usr/bin/env ruby
+require 'pathname'
+
+# path to your application root.
+APP_ROOT = Pathname.new File.expand_path('../../',  __FILE__)
+
+Dir.chdir APP_ROOT do
+  # This script is a starting point to setup your application.
+  # Add necessary setup steps to this file:
+
+  puts "== Installing dependencies =="
+  system "gem install bundler --conservative"
+  system "bundle check || bundle install"
+
+  # puts "\n== Copying sample files =="
+  # unless File.exist?("config/database.yml")
+  #   system "cp config/database.yml.sample config/database.yml"
+  # end
+
+  puts "\n== Preparing database =="
+  system "bin/rake db:setup"
+
+  puts "\n== Removing old logs and tempfiles =="
+  system "rm -f log/*"
+  system "rm -rf tmp/cache"
+
+  puts "\n== Restarting application server =="
+  system "touch tmp/restart.txt"
+end

data/spec/dummy/config.ru

@@ -0,0 +1,4 @@
+# This file is used by Rack-based servers to start the application.
+
+require ::File.expand_path('../config/environment', __FILE__)
+run Rails.application

data/spec/dummy/config/application.rb

@@ -0,0 +1,43 @@
+require File.expand_path('../boot', __FILE__)
+
+require 'active_record/railtie'
+require 'byebug'
+require 'grape'
+require 'grape-entity'
+require 'greenin'
+# Pick the frameworks you want:
+# require 'active_model/railtie'
+# require 'active_job/railtie'
+# require 'action_controller/railtie'
+# require 'action_view/railtie'
+# require 'sprockets/railtie'
+# require "rails/test_unit/railtie"
+
+# Require the gems listed in Gemfile, including any gems
+# you've limited to :test, :development, or :production.
+Bundler.require(*Rails.groups)
+
+module Dummy
+  class Application < Rails::Application
+    # Settings in config/environments/* take precedence over those specified here.
+    # Application configuration should go into files in config/initializers
+    # -- all .rb files in that directory are automatically loaded.
+
+    # Set Time.zone default to the specified zone and make Active Record auto-convert to this zone.
+    # Run "rake -D time" for a list of tasks for finding time zone names. Default is UTC.
+    # config.time_zone = 'Central Time (US & Canada)'
+
+    # The default locale is :en and all translations from config/locales/*.rb,yml are auto loaded.
+    # config.i18n.load_path += Dir[Rails.root.join('my', 'locales', '*.{rb,yml}').to_s]
+    # config.i18n.default_locale = :de
+
+    # Do not swallow errors in after_commit/after_rollback callbacks.
+    config.active_record.raise_in_transactional_callbacks = true
+    config.generators do |g|
+      g.test_framework      :rspec,        :fixture => false
+      g.fixture_replacement :factory_girl, :dir => 'spec/factories'
+      g.assets false
+      g.helper false
+    end
+  end
+end

data/spec/dummy/config/boot.rb

@@ -0,0 +1,5 @@
+# Set up gems listed in the Gemfile.
+ENV['BUNDLE_GEMFILE'] ||= File.expand_path('../../../../Gemfile', __FILE__)
+
+require 'bundler/setup' if File.exist?(ENV['BUNDLE_GEMFILE'])
+$LOAD_PATH.unshift File.expand_path('../../../../lib', __FILE__)

data/spec/dummy/config/database.yml

@@ -0,0 +1,25 @@
+# SQLite version 3.x
+#   gem install sqlite3
+#
+#   Ensure the SQLite 3 gem is defined in your Gemfile
+#   gem 'sqlite3'
+#
+default: &default
+  adapter: sqlite3
+  pool: 5
+  timeout: 5000
+
+development:
+  <<: *default
+  database: db/development.sqlite3
+
+# Warning: The database defined as "test" will be erased and
+# re-generated from your development database when you run "rake".
+# Do not set this db to the same as development or production.
+test:
+  <<: *default
+  database: db/test.sqlite3
+
+production:
+  <<: *default
+  database: db/production.sqlite3