mokei 0.0.1 → 0.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 554e4dbed3deb4a10624287592080b74bbda3043
-  data.tar.gz: ecb13e162859735de0365e132ef6fc6034a95165
+  metadata.gz: 585ba69af491c2dbd5b115dbf26a9042090d937f
+  data.tar.gz: 84e3c314e7614cca8f3ea7df53ec67f82ede4439
 SHA512:
-  metadata.gz: ebb3a887fa3b8dff1716fd255da245f00d4aa036352e3b68b41abb87fb024614b28d4ce5365f5e8f4d6bcabbf4ed6832ac1f908da54ab5c0e77c54fafe9919f0
-  data.tar.gz: f1766bb0300fbfc02b9d4439ce1c2348f243c843fc47cf7cce23022a560fbfbc53b31e69ef23d87e573a6ae6fbf653d80c92a473b9bbd1cffd261fe2f23ddbd5
+  metadata.gz: ef7b395e5c8315705d9a38dc59908c48fa4732244b7c517ff3bd356b125e48957777dbd41056e432ff9ee6ab4b5d0a814e619076105147f2fe87146d71d4fb88
+  data.tar.gz: b5fd177a289bae3978ee0ff533d9b617e64e66b4d5dfd849e3194f40b1a1ad8e29e820348cd277f94ad2bf6772b7809676759a6a7209d41d6056b0ed91d8862a

data/.travis.yml

@@ -1,5 +1,10 @@
 sudo: false
 language: ruby
 rvm:
-  - 2.4.0
+  - 2.3.4
+  - 2.4.1
+gemfile:
+  - gemfiles/rails_5.0.gemfile
+  - gemfiles/rails_5.1.gemfile
+  - gemfiles/rails_edge.gemfile
 before_install: gem install bundler -v 1.14.3

data/README.md

@@ -1,8 +1,8 @@
 # Mokei
 
-Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/mokei`. To experiment with that code, run `bin/console` for an interactive prompt.
+[![Build Status](https://travis-ci.org/y-yagi/mokei.svg?branch=master)](https://travis-ci.org/y-yagi/mokei) [![Code Climate](https://codeclimate.com/github/y-yagi/mokei/badges/gpa.svg)](https://codeclimate.com/github/y-yagi/mokei)
 
-TODO: Delete this and the text above, and describe your gem
+`Mokei` is a builder library for Rails applications. It is mainly intended for use in test.
 
 ## Installation
 
@@ -22,7 +22,60 @@ Or install it yourself as:
 
 ## Usage
 
-TODO: Write usage instructions here
+```ruby
+# migration file
+ActiveRecord::Schema.define do
+  create_table :users, force: true do |t|
+    t.string :name
+    t.string :email
+    t.boolean :active, default: false
+  end
+end
+
+# model
+class User < ActiveRecord::Base
+end
+```
+
+```ruby
+# builder
+# test/builders/user_builder.rb
+class UserBuilder < Mokei::Builder::Base
+  def dummy
+    target.email = "dummy@example.com"
+    target.name = "dummy account"
+  end
+end
+```
+
+```
+user = UserBuilder.new.dummy.build
+=> #<User id: nil, name: "dummy account", email: "dummy@example.com", active: false, created_at: nil, updated_at: nil>
+```
+
+By calling the `build` method you can get the object to build. Within the builder class, you can use the object to be built with `target`.
+
+Also, the method defined for the builder is chainable.
+
+```ruby
+# builder
+# test/builders/user_builder.rb
+class UserBuilder < Mokei::Builder::Base
+  def dummy
+    target.email = "dummy@example.com"
+    target.name = "dummy account"
+  end
+
+  def registered
+    target.active = true
+  end
+end
+```
+
+```
+user = UserBuilder.new.dummy.registered.build
+=> #<User id: nil, name: "dummy account", email: "dummy@example.com", active: true, created_at: nil, updated_at: nil>
+```
 
 ## Development
 

data/Rakefile

@@ -5,6 +5,7 @@ Rake::TestTask.new(:test) do |t|
   t.libs << "test"
   t.libs << "lib"
   t.test_files = FileList['test/**/*_test.rb']
+  t.warning = true
 end
 
 task :default => :test

data/gemfiles/rails_5.0.gemfile

@@ -0,0 +1,7 @@
+source "https://rubygems.org"
+
+gem "activesupport", "~> 5.0.0"
+gem "activerecord", "~> 5.0.0"
+gem "railties", "~> 5.0.0"
+
+gemspec path: "../"

data/gemfiles/rails_5.1.gemfile

@@ -0,0 +1,7 @@
+source "https://rubygems.org"
+
+gem "activesupport", "~> 5.1.0"
+gem "activerecord", "~> 5.1.0"
+gem "railties", "~> 5.1.0"
+
+gemspec path: "../"

data/gemfiles/rails_edge.gemfile

@@ -0,0 +1,11 @@
+source "https://rubygems.org"
+
+git "https://github.com/rails/rails.git", :branch => "master" do
+  gem "activesupport"
+  gem "activerecord"
+  gem "railties"
+end
+
+gem "arel", git: "https://github.com/rails/arel.git", branch: "master"
+
+gemspec :path => "../"

data/lib/generators/rails/mokei_generator.rb

@@ -0,0 +1,14 @@
+module Rails
+  module Generators
+    class MokeiGenerator < Rails::Generators::NamedBase
+      source_root File.expand_path("../../templates", __FILE__)
+
+      desc <<DESC
+Description:
+    Create builder files for model.
+DESC
+
+      hook_for :test_framework
+    end
+  end
+end

data/lib/generators/rspec/mokei_generator.rb

@@ -0,0 +1,9 @@
+module Rspec
+  class MokeiGenerator < ::Rails::Generators::NamedBase
+    source_root File.expand_path('../../templates', __FILE__)
+
+    def create_builder_file
+      template "builder.rb", File.join("test/builders", class_path, "#{file_name}_builder.rb")
+    end
+  end
+end

data/lib/generators/templates/builder.rb

@@ -0,0 +1,2 @@
+class <%= class_name %>Builder < Mokei::Builder::Base
+end

data/lib/generators/test_unit/mokei_generator.rb

@@ -0,0 +1,9 @@
+module TestUnit
+  class MokeiGenerator < ::Rails::Generators::NamedBase
+    source_root File.expand_path('../../templates', __FILE__)
+
+    def create_builder_file
+      template "builder.rb", File.join("test/builders", class_path, "#{file_name}_builder.rb")
+    end
+  end
+end

data/lib/mokei.rb

@@ -1,5 +1,7 @@
 require "mokei/version"
+require "mokei/load_builders"
+require "mokei/railtie"
+require "mokei/builder/base"
 
 module Mokei
-  # Your code goes here...
 end

data/lib/mokei/builder/base.rb

@@ -0,0 +1,39 @@
+require "tapper"
+require "active_support"
+require "active_support/inflector"
+
+module Mokei
+  module Builder
+    class Base
+      attr_reader :target
+
+      class << self
+        def inherited(child)
+          child.include(Tapper)
+        end
+      end
+
+      def initialize
+        target_class = determine_target(self.class.to_s)
+        @target = target_class.new
+      end
+
+      def build
+        target
+      end
+
+      def create!
+        raise NotImplementedError unless target.respond_to?(:save!)
+
+        target.save!
+        target
+      end
+
+      private
+
+      def determine_target(class_name)
+        class_name.sub!(/Builder$/, "").constantize
+      end
+    end
+  end
+end

data/lib/mokei/load_builders.rb

@@ -0,0 +1,19 @@
+module Mokei
+  class << self
+    attr_accessor :builder_paths
+  end
+
+  self.builder_paths = %w(builders test/builders)
+
+  def self.load_builders!
+    absolute_builder_paths = builder_paths.map { |path| File.expand_path(path) }
+
+    absolute_builder_paths.uniq.each do |path|
+      load("#{path}.rb") if File.exist?("#{path}.rb")
+
+      if File.directory? path
+        Dir[File.join(path, '**', '*.rb')].sort.each { |file| load file }
+      end
+    end
+  end
+end

data/lib/mokei/railtie.rb

@@ -0,0 +1,16 @@
+require "rails"
+
+module Mokei
+  class Railtie < Rails::Railtie
+    initializer "mokei.set_builder_paths" do
+      Mokei.builder_paths = [
+        Rails.root.join("builders"),
+        Rails.root.join("test", "builders")
+      ]
+    end
+
+    config.after_initialize do
+      Mokei.load_builders!
+    end
+  end
+end

data/lib/mokei/version.rb

@@ -1,3 +1,3 @@
 module Mokei
-  VERSION = "0.0.1"
+  VERSION = "0.0.2"
 end

data/mokei.gemspec

@@ -1,4 +1,3 @@
-# coding: utf-8
 lib = File.expand_path('../lib', __FILE__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 require 'mokei/version'
@@ -9,7 +8,8 @@ Gem::Specification.new do |spec|
   spec.authors       = ["Yuji Yaginuma"]
   spec.email         = ["yuuji.yaginuma@gmail.com"]
 
-  spec.summary       = %q{WIP}
+  spec.summary       = %q{`Mokei` is a builder library for Rails applications.}
+  spec.homepage      = "https://github.com/y-yagi/mokei"
   spec.license       = "MIT"
 
   spec.files         = `git ls-files -z`.split("\x0").reject do |f|
@@ -19,6 +19,12 @@ Gem::Specification.new do |spec|
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ["lib"]
 
+  spec.add_dependency "activesupport"
+  spec.add_dependency "activerecord"
+  spec.add_dependency "railties"
+  spec.add_dependency "tapper"
+  spec.add_development_dependency "byebug"
+  spec.add_development_dependency "sqlite3"
   spec.add_development_dependency "bundler", "~> 1.14"
   spec.add_development_dependency "rake", "~> 10.0"
   spec.add_development_dependency "minitest", "~> 5.0"

metadata

@@ -1,15 +1,99 @@
 --- !ruby/object:Gem::Specification
 name: mokei
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
 platform: ruby
 authors:
 - Yuji Yaginuma
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2017-02-09 00:00:00.000000000 Z
+date: 2017-08-19 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: activerecord
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: railties
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: tapper
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: byebug
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: sqlite3
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -68,10 +152,20 @@ files:
 - Rakefile
 - bin/console
 - bin/setup
+- gemfiles/rails_5.0.gemfile
+- gemfiles/rails_5.1.gemfile
+- gemfiles/rails_edge.gemfile
+- lib/generators/rails/mokei_generator.rb
+- lib/generators/rspec/mokei_generator.rb
+- lib/generators/templates/builder.rb
+- lib/generators/test_unit/mokei_generator.rb
 - lib/mokei.rb
+- lib/mokei/builder/base.rb
+- lib/mokei/load_builders.rb
+- lib/mokei/railtie.rb
 - lib/mokei/version.rb
 - mokei.gemspec
-homepage: 
+homepage: https://github.com/y-yagi/mokei
 licenses:
 - MIT
 metadata: {}
@@ -91,8 +185,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.6.8
+rubygems_version: 2.6.12
 signing_key: 
 specification_version: 4
-summary: WIP
+summary: "`Mokei` is a builder library for Rails applications."
 test_files: []