geckorate 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 3b4a0eb4dd2abcd1c8e09b079521270efa61374f07bbacf748fff6b8b53a0efe
+  data.tar.gz: 13240fe99a8bf10d132ff5c99053fe21e301a608559f5c074ab3a1538a258eb4
+SHA512:
+  metadata.gz: 36631b16505625736a025546b8f6965c528a710f40be461b41627838eb97778bf2229ad50ca2ce8a94b6b3730fc83fad4062db808f8802f99644820609d32227
+  data.tar.gz: adeeb69a7ab6c6c7d687b83aa4d67fa4bcda7e5e1bc22f758fbf6346dc6f0dac291bd617860294890b53611e7f4e7ba3b3f1ea0f23cc0b6a9086dce4ffbe100d

data/.gitignore

@@ -0,0 +1,9 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+*.gem

data/.travis.yml

@@ -0,0 +1,5 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.5.0
+before_install: gem install bundler -v 1.16.1

data/Gemfile

@@ -0,0 +1,6 @@
+source "https://rubygems.org"
+
+git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in geckorate.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2018 Ahmed Saleh
+
+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,96 @@
+# Geckorate
+
+A dead simple decorator for Ruby
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'geckorate'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install geckorate
+
+## Usage
+
+### A Rails example
+
+Define your decorator as such:
+
+```ruby
+# app/decorators/post_decorator.rb
+
+class PostDecorator < Geckorate::Decorator
+  def decorate
+    {
+      title: title,
+      username: user.name
+    }.to_json
+  end
+end
+```
+
+and initialize it in your controller and use it for your view:
+```ruby
+# app/controllers/posts_contrller.rb
+
+class PostsController < ApplicationController
+  def show
+    post           = Post.find(params[:id])
+    decorated_post = PostDecorator.new(post).decorate
+
+    render json: { post: decorated_post }
+  end
+end
+```
+
+### For collections
+
+There's a method `decorate_collection(collection)` for decorating collections.
+Example: `PostDecorator.decorate_collection(Post.all)` returns an array of
+decorated Post objects.
+
+### With paginated collections
+
+Currently, there are two methods for pagination; one for Kaminari
+`decorate_kaminari_collection(collection)` and another for will_paginate
+`decorate_will_paginate_collection(collection)`. The returned hash from both
+methods looks like this:
+
+```ruby
+{
+  page: 1,
+  per_page: 25,
+  total: 100,
+  records: [{...}, {...}]
+}
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run
+`rake test` to run the tests. You can also run `bin/console` for an interactive
+prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To
+release a new version, update the version number in `version.rb`, and then run
+`bundle exec rake release`, which will create a git tag for the version, push
+git commits and tags, and push the `.gem` file to
+[rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at
+https://github.com/aonemd/geckorate.
+
+## License
+
+The gem is available as open source under the terms of the
+[MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,10 @@
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << "test"
+  t.libs << "lib"
+  t.test_files = FileList["test/**/*_test.rb"]
+end
+
+task :default => :test

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "geckorate"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/geckorate.gemspec

@@ -0,0 +1,25 @@
+
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "geckorate/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "geckorate"
+  spec.version       = Geckorate::VERSION
+  spec.authors       = ["Ahmed Saleh"]
+  spec.email         = ["aonemdsaleh@gmail.com"]
+
+  spec.summary       = %q{A dead simple decorator for Ruby}
+  spec.description   = %q{A dead simple decorator for Ruby}
+  spec.homepage      = "https://github.com/aonemd/geckorate"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.16"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "minitest", "~> 5.0"
+end

data/lib/geckorate/version.rb

@@ -0,0 +1,3 @@
+module Geckorate
+  VERSION = "0.1.0"
+end

data/lib/geckorate.rb

@@ -0,0 +1,36 @@
+require "geckorate/version"
+
+module Geckorate
+  class Decorator < SimpleDelegator
+    def decorate; end
+
+    class << self
+      def decorate_collection(collection)
+        collection.map do |item|
+          klass           = item.class
+          full_klass_name = klass.to_s.concat('Decorator')
+          decorator_klass = Class.const_get(full_klass_name)
+          decorator_klass.new(item).decorate
+        end
+      end
+
+      def decorate_kaminari_collection(collection)
+        {
+          page: collection.current_page,
+          per_page: collection.current_per_page,
+          total: collection.total_count,
+          records: decorate_collection(collection)
+        }
+      end
+
+      def decorate_will_paginate_collection(collection)
+        {
+          page: collection.current_page,
+          per_page: collection.per_page,
+          total: collection.total_entries,
+          records: decorate_collection(collection)
+        }
+      end
+    end
+  end
+end

metadata

@@ -0,0 +1,97 @@
+--- !ruby/object:Gem::Specification
+name: geckorate
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Ahmed Saleh
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2018-06-22 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+- !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'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+description: A dead simple decorator for Ruby
+email:
+- aonemdsaleh@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- geckorate.gemspec
+- lib/geckorate.rb
+- lib/geckorate/version.rb
+homepage: https://github.com/aonemd/geckorate
+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.7.3
+signing_key: 
+specification_version: 4
+summary: A dead simple decorator for Ruby
+test_files: []