is_published 0.1.2 → 0.1.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7a19de810fed315d96c0bab71b45d4040cc117fdd718c81f5a1e85a8c94d971d
-  data.tar.gz: b1198cd1dc86c45b9e48c77c437f9f180365e03bfd99794d68d3f867384f0f9c
+  metadata.gz: ed08f98a881c6c1ee29ca1ab7d5d29d3e07af03b62aaf585ac3573dd4a1ed2ee
+  data.tar.gz: 6bdd2c7f1e06031d41acb8076c064f798c025b954fd9c3845b737d4bf9ea3447
 SHA512:
-  metadata.gz: 5eab8e3e239c2f5f06f3619ebc90814901cd9be2a9e490ce44617a417ba5a5cc3a3ac9a6d34d0decac36cc007232810523dd52f9f382c52bf2439f49a2b68fa4
-  data.tar.gz: cfa2e0fc0d819ef1a510ccc7865a493cad546fce815c6015e4c26311488919a9db727adbe6e69bae2c50ce285cc688f4f2d4094570689ad94f032800eaf70a8f
+  metadata.gz: 04144ce97523798522224e2a5ffaa1b0ac4a932ed15f6dd5b80494d99fb2087f2b9852c40283b4e9de858719c5b86564038ced5da42d2892a848fdf6c3ee5c6a
+  data.tar.gz: 5cd3d92e8f430d67e966b999550cb4adc419b67dc81b0d277b9840583c422a9f575ea07bca4970a8c15ef85d10b08be301d2b184303721e86166345f3bb59c24

data/.gitignore

@@ -11,3 +11,5 @@
 .rspec_status
 
 \.idea/
+
+*.gem

data/Gemfile.lock

@@ -1,12 +1,25 @@
 PATH
   remote: .
   specs:
-    is_published (0.1.2)
+    is_published (0.1.3)
       activerecord (>= 3.0)
 
 GEM
   remote: https://rubygems.org/
   specs:
+    actionpack (5.2.3)
+      actionview (= 5.2.3)
+      activesupport (= 5.2.3)
+      rack (~> 2.0)
+      rack-test (>= 0.6.3)
+      rails-dom-testing (~> 2.0)
+      rails-html-sanitizer (~> 1.0, >= 1.0.2)
+    actionview (5.2.3)
+      activesupport (= 5.2.3)
+      builder (~> 3.1)
+      erubi (~> 1.4)
+      rails-dom-testing (~> 2.0)
+      rails-html-sanitizer (~> 1.0, >= 1.0.3)
     activemodel (5.2.3)
       activesupport (= 5.2.3)
     activerecord (5.2.3)
@@ -19,11 +32,38 @@ GEM
       minitest (~> 5.1)
       tzinfo (~> 1.1)
     arel (9.0.0)
+    builder (3.2.3)
     concurrent-ruby (1.1.5)
+    crass (1.0.4)
     diff-lcs (1.3)
+    erubi (1.8.0)
+    generator_spec (0.9.4)
+      activesupport (>= 3.0.0)
+      railties (>= 3.0.0)
     i18n (1.6.0)
       concurrent-ruby (~> 1.0)
+    loofah (2.2.3)
+      crass (~> 1.0.2)
+      nokogiri (>= 1.5.9)
+    method_source (0.9.2)
+    mini_portile2 (2.4.0)
     minitest (5.11.3)
+    nokogiri (1.10.3)
+      mini_portile2 (~> 2.4.0)
+    rack (2.0.7)
+    rack-test (1.1.0)
+      rack (>= 1.0, < 3)
+    rails-dom-testing (2.0.3)
+      activesupport (>= 4.2.0)
+      nokogiri (>= 1.6)
+    rails-html-sanitizer (1.0.4)
+      loofah (~> 2.2, >= 2.2.2)
+    railties (5.2.3)
+      actionpack (= 5.2.3)
+      activesupport (= 5.2.3)
+      method_source
+      rake (>= 0.8.7)
+      thor (>= 0.19.0, < 2.0)
     rake (10.5.0)
     rspec (3.8.0)
       rspec-core (~> 3.8.0)
@@ -39,6 +79,7 @@ GEM
       rspec-support (~> 3.8.0)
     rspec-support (3.8.0)
     sqlite3 (1.4.0)
+    thor (0.20.3)
     thread_safe (0.3.6)
     tzinfo (1.2.5)
       thread_safe (~> 0.1)
@@ -48,6 +89,7 @@ PLATFORMS
 
 DEPENDENCIES
   bundler (~> 2.0)
+  generator_spec
   is_published!
   rake (~> 10.0)
   rspec (~> 3.2)

data/README.md

@@ -18,8 +18,56 @@ Or install it manually on local machine
 
     $ gem install is_published
 
-## Usage
-Before all, class you want to extend with this gem, needs to have column 'published' in the database.
+## Model and migrations
+##### Before all. Class you want to extend with this gem, needs to have column 'published' in the database.
+
+###-- If you dont have created migrations and model
+
+Gem comes with migrations and model generator, you can create one with this command:
+
+```ruby
+rails g is_published:install [MODEL NAME]
+```
+
+For example:
+
+    rails g is_published:install Article  
+
+which will create model and migrations with provided name.
+
+Migration will look like this
+```ruby
+class CreateArticles < ActiveRecord::Migration
+  def change
+    create_table :articles do |t|
+      t.string :title
+      t.string :body
+      t.boolean :published, default: false
+      t.timestamps
+    end
+  end
+end
+```
+Model class comes with already extended gem scope, its going to look like this one
+
+```ruby
+class Article < ApplicationRecord
+  extend IsPublished::Scopes
+end
+```
+
+If needed, you can customize migrations before running them.
+
+After running generator command, run migration.
+
+    rails db:migrate
+    
+####And you are good to go! Proceed to gem usage information!
+
+
+
+*** 
+## -- If you have already model and migrations
 
 If your model table already exists, you can create migration to add published column like this:
 
@@ -49,8 +97,10 @@ class Post < ApplicationRecord
 end
 ```
 
-Then you can use it like every other scope 
+Now you are done.
 
+## Gem usage
+After you are done with migrations and model setup, you can use published scope like this.
 ```ruby
 Post.published 
 #=>  => #<Post id: 1, title: "Published post", user_id: 1, published: true, created_at: "2019-06-07 14:42:22", updated_at: "2019-06-07 16:51:07">

data/is_published.gemspec

@@ -25,6 +25,7 @@ Gem::Specification.new do |spec|
   spec.require_paths = ["lib"]
 
   spec.add_dependency "activerecord", ">= 3.0"
+  spec.add_development_dependency 'generator_spec'
   spec.add_development_dependency 'sqlite3'
   spec.add_development_dependency "bundler", "~> 2.0"
   spec.add_development_dependency "rake", "~> 10.0"

data/lib/is_published.rb

@@ -1,5 +1,6 @@
 require "is_published/version"
 require "is_published/scopes"
+require "is_published/generators/install_generator"
 require 'active_record'
 
 module IsPublished

data/lib/is_published/generators/install_generator.rb

@@ -0,0 +1,31 @@
+require 'rails/generators'
+require 'rails/generators/migration'
+
+module IsPublished
+  module Generators
+    class InstallGenerator < ::Rails::Generators::Base
+      include Rails::Generators::Migration
+      source_root File.expand_path('../templates', __FILE__)
+      desc "Add the migrations for IsPublished"
+      argument :model_name, type: :string, default: 'post'
+
+      def self.next_migration_number(path)
+        next_migration_number = current_migration_number(path) + 1
+        ActiveRecord::Migration.next_migration_number(next_migration_number)
+      end
+
+      def copy_migrations
+        migration_template "create_migration.erb",
+                           "db/migrate/create_#{model_name.underscore.pluralize}.rb"
+      end
+
+      def create_model
+        create_file "app/models/#{model_name.underscore}.rb", "
+class #{model_name.capitalize} < ApplicationRecord
+  extend IsPublished::Scopes
+end
+"
+      end
+    end
+  end
+end

data/lib/is_published/generators/templates/create_migration.erb

@@ -0,0 +1,10 @@
+class Create<%= model_name.capitalize.pluralize %> < ActiveRecord::Migration
+  def change
+    create_table :<%= model_name.underscore.pluralize %> do |t|
+      t.string :title
+      t.string :body
+      t.boolean :published, default: false
+      t.timestamps
+    end
+  end
+end

data/lib/is_published/version.rb

@@ -1,3 +1,3 @@
 module IsPublished
-  VERSION = "0.1.2"
+  VERSION = "0.1.3"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: is_published
 version: !ruby/object:Gem::Version
-  version: 0.1.2
+  version: 0.1.3
 platform: ruby
 authors:
 - Jacek Kowalski
@@ -24,6 +24,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: generator_spec
+  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
@@ -102,6 +116,8 @@ files:
 - bin/setup
 - is_published.gemspec
 - lib/is_published.rb
+- lib/is_published/generators/install_generator.rb
+- lib/is_published/generators/templates/create_migration.erb
 - lib/is_published/scopes.rb
 - lib/is_published/version.rb
 homepage: https://github.com/Eviath/is_published.git