readable_model 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 1bec5630c1436e77ba7f9325b5cf99ba9f73a842
+  data.tar.gz: d78740cdd291a1ac96a759f99759a37083ce2c19
+SHA512:
+  metadata.gz: 7a1574556457f4badd36eb97b48295a78573522bf6d51aeecb051ca1a1e3981058e6bd3d2142292df18fe5f5dd46ed7fb3ac19cb0533db639ec7743223b3293a
+  data.tar.gz: ba94589f75fbcafc20a10bdb1cb5443945f44c3d58d3b77fa297f76f86343c53b7541b5e2a9fa1e4716658f102fc8703c93aec919f69a364acf69c2ae42055cd

data/.gitignore

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

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2015 senthil
+
+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,113 @@
+# ReadableModel
+
+This gem doesn't do any logical opertaion. Just make the MVC - Model as much as readable.
+This library adds the model template as per the rails style guide.
+https://github.com/bbatsov/rails-style-guide#activerecord
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'readable_model'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install readable_model
+
+## Usage
+
+```ruby
+rails generate scaffold scaffold_name
+```
+
+or
+
+```ruby
+rails generate model model_name
+```
+
+Now check your model file
+
+## Before readable_model template
+
+```ruby
+class User < ActiveRecord::Base
+  include UrlHelper
+  serialize :template
+  belongs_to :country
+
+  alias_attribute :subject, :title
+
+  has_one :photo
+  has_many :authentications, dependent: :destroy, inverse_of: :user
+  has_many :items, dependent: :destroy, counter_cache: true
+
+  self.table_name = "admin_users"
+  validates :email, presence: true
+  validates :username, presence: true
+
+  before_save :cook
+  after_create :update_item
+  validates :username, uniqueness: { case_sensitive: false }
+
+  COLORS = ['red', 'green', 'blue']
+  attr_accessor :date
+  @@per_page = 10
+  scope :blocked, -> { where(active: false }
+  delegate :name, :address, to: :order, prefix: :order
+  serialize :rule_options
+
+  def role
+    role_type.inquiry
+  end
+end
+```
+## After readable_model template
+
+```ruby
+class User < ActiveRecord::Base
+  include UrlHelper
+
+  # Default Scope
+  default_scope { where(active: true) }
+
+  # Configurations
+  self.table_name = "admin_users"
+  COLORS = ['red', 'green', 'blue']
+  @@per_page = 10
+
+  # Attributes
+  attr_accessor :date
+  alias_attribute :subject, :title
+  delegate :name, :address, to: :order, prefix: :order
+  serialize :template
+
+  # Associations
+  has_one :photo
+  has_many :authentications, dependent: :destroy, inverse_of: :user
+  has_many :items, dependent: :destroy, counter_cache: true
+  belongs_to :country
+
+  # Validations
+  validates :email, presence: true
+  validates :username, presence: true
+  validates :username, uniqueness: { case_sensitive: false }
+
+  # Callbacks
+  before_save :cook
+  after_create :update_item
+
+  # Scopes
+  scope :blocked, -> { where(active: false }
+
+  def role
+    role_type.inquiry
+  end
+end
+```

data/Rakefile

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

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "readable_model"
+
+# 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

data/bin/setup

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

data/lib/readable_model/railtie.rb

@@ -0,0 +1,7 @@
+module ReadableModel
+  class Railtie < Rails::Railtie
+    config.app_generators do |g|
+      g.templates.unshift File::expand_path('../../templates', __FILE__)
+    end
+  end
+end

data/lib/readable_model/version.rb

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

data/lib/readable_model.rb

@@ -0,0 +1,6 @@
+require "readable_model/version"
+require "readable_model/railtie"
+
+module ReadableModel
+
+end

data/lib/templates/active_record/model/model.rb

@@ -0,0 +1,22 @@
+<% module_namespacing do -%>
+class <%= class_name %> < <%= parent_class_name.classify %>
+
+  # Default Scope
+
+  # Configurations
+
+  # Attributes
+  <% if attributes.any?(&:password_digest?) -%>
+    has_secure_password
+  <% end -%>
+
+  # Associations
+
+  # Validations
+
+  # Callbacks
+
+  # Scopes
+
+end
+<% end -%>

data/readable_model.gemspec

@@ -0,0 +1,24 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'readable_model/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "readable_model"
+  spec.version       = ReadableModel::VERSION
+  spec.authors       = ["senthil"]
+  spec.email         = ["rask.kumar@gmail.com"]
+
+  spec.summary       = %q{Make Model as much as readable}
+  spec.description   = %q{Make Model as much as readable}
+  spec.homepage      = "https://github.com/senthil88/readable_model"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.8"
+  spec.add_development_dependency "rake", "~> 10.0"
+end

metadata

@@ -0,0 +1,84 @@
+--- !ruby/object:Gem::Specification
+name: readable_model
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- senthil
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2015-06-01 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.8'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.8'
+- !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: Make Model as much as readable
+email:
+- rask.kumar@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/readable_model.rb
+- lib/readable_model/railtie.rb
+- lib/readable_model/version.rb
+- lib/templates/active_record/model/model.rb
+- readable_model.gemspec
+homepage: https://github.com/senthil88/readable_model
+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.4.6
+signing_key: 
+specification_version: 4
+summary: Make Model as much as readable
+test_files: []