greenin 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 4fcec74c431a69a9192f8ee8f7436e7c48b17d40
+  data.tar.gz: 16e62b0207b720d947f5d8a5c6142def7355b9dc
+SHA512:
+  metadata.gz: de5a60367ba83a4c2426a8165e49e1c190b958fa2c0711a6b13f658c09ad30312ebe194585d711e50974640e8c596a72d2351f39faf59492cf06c7baf2a9b30e
+  data.tar.gz: f3a65a127430d94abcd9419c1b5b420509356b16b154364d84b60bd10f58224b7459bb72fb33e7c118d6d04ebe52e2f01822ee26324ebc724b83b0283c8d338a

data/.gitignore

@@ -0,0 +1,14 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in greenin.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2015 Russkikh Artem
+
+MIT License
+
+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,82 @@
+# Greenin
+
+Describe your Grape Entities in Rails Active Record models
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'greenin'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install greenin
+
+Then run
+
+	$ rails g greenin:install
+
+This generator creates an initializer with settings at `config/initializers/greenin_initializer.rb`. You can change method name and class name:
+```ruby
+Greenin.setup do |config|
+  config.entity_method_name = 'entity'
+  config.entity_class_name = 'Entity'
+end
+
+```
+
+## Usage
+
+Example describtion in Post model:
+
+```ruby
+class Post < ActiveRecord::Base
+
+  # ...
+
+  class Entity < Grape::Entity
+    format_with(:unix) { |dt| dt.to_i }
+    root 'posts'
+
+    expose :id
+    with_options(format_with: :unix) do
+      expose :created_at
+      expose :updated_at
+    end
+    expose :title
+    expose :description
+  end
+
+end
+```
+
+So, now you can call entity like that:
+```ruby
+Post::Entity
+# => Post::Entity
+
+Post.entity
+# => Post::Entity
+
+Post.all.entity
+# => #<Post::Entity:0x007fb4610d8a00
+#    @object=#<ActiveRecord::Relation [...]>, @options={}>
+
+Post.first.entity
+# => #<Post::Entity:0x007fb462263090 @object=
+#    #<Post id: nil, ..., created_at: nil, updated_at: nil>, @options={}>
+```
+
+## Contributing
+
+1. Fork it ( https://github.com/itbeaver/greenin/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create a new Pull Request

data/Rakefile

@@ -0,0 +1,2 @@
+require "bundler/gem_tasks"
+

data/greenin.gemspec

@@ -0,0 +1,23 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'greenin/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'greenin'
+  spec.version       = Greenin::VERSION
+  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.homepage      = 'http://itbeaver.co'
+  spec.license       = 'MIT'
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(/^bin\//) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(/^(test|spec|features)\//)
+  spec.require_paths = ['lib']
+
+  spec.add_development_dependency 'bundler', '~> 1.7'
+  spec.add_development_dependency 'rake', '~> 10.0'
+end

data/lib/active_record_overrides.rb

@@ -0,0 +1,50 @@
+module ActiveRecord
+  # Public: Add entity method to ActiveRecord::Relation class
+  #
+  # Examples
+  #
+  #   User.all.entity
+  #   # => #<User::Entity:0x007fb4610d8a00
+  #        @object=#<ActiveRecord::Relation [...]>, @options={}>
+  class Relation
+    define_method(Greenin.entity_method_name) do
+      begin
+        entity = %(#{model}::#{Greenin.entity_class_name}).constantize
+      rescue NameError
+        entity = nil
+      end
+      entity.new(self) if entity
+    end
+  end
+
+  # Public: Add entity methods to ActiveRecord::Base class
+  #
+  # Examples
+  #
+  #   User.entity
+  #   # => User::Entity
+  #
+  #   User.new.entity
+  #   # => #<User::Entity:0x007fb462263090 @object=
+  #        #<User id: nil, ..., created_at: nil, updated_at: nil>, @options={}>
+  class Base
+    define_singleton_method Greenin.entity_method_name do
+      begin
+        entity = %(#{self}::#{Greenin.entity_class_name}).constantize
+      rescue NameError
+        entity = nil
+      end
+      entity.new(self) if entity
+    end
+
+    define_method(Greenin.entity_method_name) do
+      begin
+        entity = %(#{self.class}::#{Greenin.entity_class_name})
+                 .constantize
+      rescue NameError
+        entity = nil
+      end
+      entity.new(self) if entity
+    end
+  end
+end

data/lib/generators/greenin/install/install_generator.rb

@@ -0,0 +1,15 @@
+module Greenin
+  # Public: Add generator to project.
+  # Generator copies initializer to app
+  #
+  # Example:
+  #
+  #   rails g greenin:install
+  class InstallGenerator < Rails::Generators::Base
+    source_root File.expand_path('../templates', __FILE__)
+    desc 'This generator creates an initializer file at config/initializers'
+    def create_initializer_file
+      copy_file 'initializer.rb', 'config/initializers/greenin_initializer.rb'
+    end
+  end
+end

data/lib/generators/greenin/install/templates/initializer.rb

@@ -0,0 +1,4 @@
+Greenin.setup do |config|
+  config.entity_method_name = 'entity'
+  config.entity_class_name = 'Entity'
+end

data/lib/greenin/version.rb

@@ -0,0 +1,3 @@
+module Greenin
+  VERSION = '1.0.0'
+end

data/lib/greenin.rb

@@ -0,0 +1,39 @@
+require 'greenin/version'
+
+# Public: Greenin settings module
+# You can customize entity method name and entity class name
+#
+# Examples
+#
+#   Greenin.entity_method_name = 'form_ent'
+#   Greenin.entity_class_name = 'Ent'
+#
+#   User::Ent
+#   # => User::Ent
+#   User.form_ent
+#   # => User::Entity
+#   User.all.form_ent
+#   # => #<User::Entity:0x007fb4610d8a00
+#        @object=#<ActiveRecord::Relation [...]>, @options={}>
+#   User.first.form_ent
+#   # => #<User::Entity:0x007fb462263090 @object=
+#        #<User id: nil, ..., created_at: nil, updated_at: nil>, @options={}>
+module Greenin
+  mattr_accessor :entity_method_name
+  @@entity_method_name = 'entity'
+
+  mattr_accessor :entity_class_name
+  @@entity_class_name = 'Entity'
+
+  def self.setup
+    yield self
+  end
+end
+
+# Public: Generates methods after loading initializer
+class Engine < ::Rails::Engine
+  initializer 'set_settings', after: :load_config_initializers,
+                              before: :build_middleware_stack do
+    require 'active_record_overrides'
+  end
+end

metadata

@@ -0,0 +1,84 @@
+--- !ruby/object:Gem::Specification
+name: greenin
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Russkikh Artem
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-02-23 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+description: Describe your Grape Entities in Rails Active Record models
+email:
+- russkikhartem@itbeaver.co
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- greenin.gemspec
+- lib/active_record_overrides.rb
+- lib/generators/greenin/install/install_generator.rb
+- lib/generators/greenin/install/templates/initializer.rb
+- lib/greenin.rb
+- lib/greenin/version.rb
+homepage: http://itbeaver.co
+licenses:
+- MIT
+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.2.2
+signing_key: 
+specification_version: 4
+summary: Grape Entities in Rails models
+test_files: []
+has_rdoc: