Skip to content
This repository was archived by the owner on Jun 11, 2022. It is now read-only.

Commit

Permalink
Initial commit
Browse files Browse the repository at this point in the history
  • Loading branch information
ramontayag committed Jun 29, 2015
0 parents commit c185816
Show file tree
Hide file tree
Showing 64 changed files with 1,177 additions and 0 deletions.
10 changes: 10 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
.bundle/
log/*.log
pkg/
spec/dummy/db/*.sqlite3
spec/dummy/db/*.sqlite3-journal
spec/dummy/log/*.log
spec/dummy/tmp/
spec/dummy/.sass-cache
spec/examples.txt
Gemfile.lock
2 changes: 2 additions & 0 deletions .rspec
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
--color
--require spec_helper
3 changes: 3 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
# 0.0.1

- Initial release
16 changes: 16 additions & 0 deletions Gemfile
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
source 'https://rubygems.org'

# Declare your gem's dependencies in active_model_serializers_contrib.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
# gem 'byebug', group: [:development, :test]

gem "pry"
20 changes: 20 additions & 0 deletions MIT-LICENSE
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
Copyright 2015 G5

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.
61 changes: 61 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,61 @@
# ActiveModelSerializers Contrib

Extend AMS with classes/modules.

Currently, it assumes that you're using `kaminari` to paginate. This has not been tested with `will_paginate`.

# Usage

## ActiveModel::PaginationSerializer

```ruby
class BooksController < ApplicationController
respond_to :json

def index
book = Book.page(params[:page])
respond_with book, serializer: ActiveModel::PaginationSerializer
end
end
```

You will get a response like this:

```json
{
books: [
{ id: 1, name: "The Great Voyage" },
...
],
meta: {
current_page: 1,
total_pages: 4,
total: 40,
prev_page: nil,
next_page: 2
}
}
```

# License

Copyright 2015 G5

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.
23 changes: 23 additions & 0 deletions Rakefile
Original file line number Diff line number Diff line change
@@ -0,0 +1,23 @@
begin
require 'bundler/setup'
rescue LoadError
puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
end

require 'rdoc/task'

RDoc::Task.new(:rdoc) do |rdoc|
rdoc.rdoc_dir = 'rdoc'
rdoc.title = 'ActiveModelSerializersContrib'
rdoc.options << '--line-numbers'
rdoc.rdoc_files.include('README.rdoc')
rdoc.rdoc_files.include('lib/**/*.rb')
end






Bundler::GemHelper.install_tasks

28 changes: 28 additions & 0 deletions active_model_serializers_contrib.gemspec
Original file line number Diff line number Diff line change
@@ -0,0 +1,28 @@
$:.push File.expand_path("../lib", __FILE__)

# Maintain your gem's version:
require "active_model_serializers_contrib/version"

# Describe your gem and declare its dependencies:
Gem::Specification.new do |s|
s.name = "active_model_serializers_contrib"
s.version = ActiveModelSerializersContrib::VERSION
s.authors = ["G5", "Ramon Tayag"]
s.email = ["[email protected]", "[email protected]"]
s.homepage = "https://github.com/g5/active_model_serializers_contrib"
s.summary = "Modules/classes that extend AMS with more functionality"
s.description = "Modules/classes that extend AMS with more functionality"
s.license = "MIT"

s.files = Dir["{app,config,db,lib}/**/*", "MIT-LICENSE", "Rakefile", "README.rdoc"]

s.add_dependency "active_model_serializers"

s.add_development_dependency "sqlite3"
s.add_development_dependency "rails", "~> 4.2.3"
s.add_development_dependency "factory_girl_rails"
s.add_development_dependency "rspec-rails"
s.add_development_dependency "responders"
s.add_development_dependency "database_cleaner"
s.add_development_dependency "kaminari"
end
26 changes: 26 additions & 0 deletions lib/active_model/pagination_serializer.rb
Original file line number Diff line number Diff line change
@@ -0,0 +1,26 @@
class ActiveModel::PaginationSerializer < ActiveModel::ArraySerializer

def initialize_with_pagination(object, opts={})
per_page = object.limit_value
offset = object.offset_value
current_page = offset ? (offset / per_page) + 1 : 1
total_objects = object.limit(nil).offset(nil).count
total_pages = per_page ? (total_objects / per_page).ceil : 1
prev_page = current_page - 1
prev_page = nil if prev_page < 1
next_page = current_page + 1
next_page = nil if next_page > total_pages

opts[:meta] ||= {}
opts[:meta][:current_page] = current_page
opts[:meta][:total_pages] = total_pages
opts[:meta][:total] = total_objects
opts[:meta][:prev_page] = prev_page
opts[:meta][:next_page] = next_page

initialize_without_pagination(object, opts)
end

alias_method_chain :initialize, :pagination

end
5 changes: 5 additions & 0 deletions lib/active_model_serializers_contrib.rb
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
require "active_model_serializers"
require "active_model/pagination_serializer"

module ActiveModelSerializersContrib
end
2 changes: 2 additions & 0 deletions lib/active_model_serializers_contrib/pagination_serializer.rb
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
class PaginationSerializer < ActiveModel::ArraySerializer
end
3 changes: 3 additions & 0 deletions lib/active_model_serializers_contrib/version.rb
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
module ActiveModelSerializersContrib
VERSION = "0.0.1"
end
4 changes: 4 additions & 0 deletions lib/tasks/active_model_serializers_contrib_tasks.rake
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
# desc "Explaining what the task does"
# task :active_model_serializers_contrib do
# # Task goes here
# end
28 changes: 28 additions & 0 deletions spec/dummy/README.rdoc
Original file line number Diff line number Diff line change
@@ -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>.
6 changes: 6 additions & 0 deletions spec/dummy/Rakefile
Original file line number Diff line number Diff line change
@@ -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
Empty file.
13 changes: 13 additions & 0 deletions spec/dummy/app/assets/javascripts/application.js
Original file line number Diff line number Diff line change
@@ -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/rails/sprockets#sprockets-directives) for details
// about supported directives.
//
//= require_tree .
2 changes: 2 additions & 0 deletions spec/dummy/app/assets/javascripts/books.js
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
// Place all the behaviors and hooks related to the matching controller here.
// All this logic will automatically be available in application.js.
15 changes: 15 additions & 0 deletions spec/dummy/app/assets/stylesheets/application.css
Original file line number Diff line number Diff line change
@@ -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
*/
4 changes: 4 additions & 0 deletions spec/dummy/app/assets/stylesheets/books.css
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
/*
Place all the styles related to the matching controller here.
They will automatically be included in application.css.
*/
5 changes: 5 additions & 0 deletions spec/dummy/app/controllers/application_controller.rb
Original file line number Diff line number Diff line change
@@ -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
15 changes: 15 additions & 0 deletions spec/dummy/app/controllers/books_controller.rb
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
class BooksController < ApplicationController

respond_to :json

def index
books = Book.page(params[:page]).per(params[:per_page])
respond_with books, serializer: ActiveModel::PaginationSerializer
end

def no_pagination
books = Book.all
respond_with books, serializer: ActiveModel::PaginationSerializer
end

end
Empty file.
2 changes: 2 additions & 0 deletions spec/dummy/app/helpers/application_helper.rb
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
module ApplicationHelper
end
2 changes: 2 additions & 0 deletions spec/dummy/app/helpers/books_helper.rb
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
module BooksHelper
end
Empty file added spec/dummy/app/mailers/.keep
Empty file.
Empty file added spec/dummy/app/models/.keep
Empty file.
2 changes: 2 additions & 0 deletions spec/dummy/app/models/book.rb
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
class Book < ActiveRecord::Base
end
Empty file.
13 changes: 13 additions & 0 deletions spec/dummy/app/views/layouts/application.html.erb
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
<!DOCTYPE html>
<html>
<head>
<title>Dummy</title>
<%= stylesheet_link_tag 'application', media: 'all' %>
<%= csrf_meta_tags %>
</head>
<body>

<%= yield %>

</body>
</html>
3 changes: 3 additions & 0 deletions spec/dummy/bin/bundle
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
#!/usr/bin/env ruby
ENV['BUNDLE_GEMFILE'] ||= File.expand_path('../../Gemfile', __FILE__)
load Gem.bin_path('bundler', 'bundle')
4 changes: 4 additions & 0 deletions spec/dummy/bin/rails
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
#!/usr/bin/env ruby
APP_PATH = File.expand_path('../../config/application', __FILE__)
require_relative '../config/boot'
require 'rails/commands'
4 changes: 4 additions & 0 deletions spec/dummy/bin/rake
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
#!/usr/bin/env ruby
require_relative '../config/boot'
require 'rake'
Rake.application.run
29 changes: 29 additions & 0 deletions spec/dummy/bin/setup
Original file line number Diff line number Diff line change
@@ -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
4 changes: 4 additions & 0 deletions spec/dummy/config.ru
Original file line number Diff line number Diff line change
@@ -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
Loading

0 comments on commit c185816

Please sign in to comment.