schema_dev 3.0.1 → 3.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: bd6c69cfe0a866b68f7a79231a8beb2a4c5bda9d
-  data.tar.gz: 7371f48ae6592f72c3420d77de7455b076ffb386
+  metadata.gz: f5bfa06af8b9f00fffcb689a75ca9660c956241c
+  data.tar.gz: d09915f7524f4e4a3dafcb2a0501c47d54185c08
 SHA512:
-  metadata.gz: 989dd3e71793ad318c6bcb41ef1e7bace17ed0f354455ac87110b4c9605efb0be7c15ff3bcb27994c752153df246b67b34d8d53a15ef629d04b80ba26cd2c913
-  data.tar.gz: f3e25a5b2a4afb82bd4a9898760771ed7d1bfb3df6d6429df9acc4de0c1df43c294a61ac68384994c2bc36ece42fb69251a60830692e254ab96b6b31a5859838
+  metadata.gz: 99bf2a55254c90452aefa89e0afab3c40affdb320c957e92dd46eba4867d16de386780b96a00630eebd1b6edacdb5889a8a654bed750831282549f810d30c58a
+  data.tar.gz: 062cdcfbf0f1e41cbead8ca3b7b1983248cbdc04e936eb11cecd3bbbd315db3dfd22b5fffe8dbbaff7cda692317ebe8ae66b64005401037cd4a9c3ef1d141c6b

data/lib/schema_dev/gem.rb

@@ -15,14 +15,14 @@ module SchemaDev
 
     def initialize(name)
       self.gem_name = name.underscore
-      self.gem_module = gem_name.camelize
+      self.gem_module = gem_name.camelize.sub(/^SchemaPlus(?=\w+)/, 'SchemaPlus::')
       self.gem_root = Pathname.new(gem_name)
+      get_fullname_and_email
     end
 
     def build
       ensure_not_in_git
       ensure_doesnt_exist
-      get_fullname_and_email
       copy_template
       self.gem_root = self.gem_root.realpath
       rename_files
@@ -66,6 +66,7 @@ module SchemaDev
 
     def copy_template
       FileUtils.cp_r Templates.root + "gem", gem_root
+      (gem_root + "gitignore").rename gem_root + ".gitignore"
     end
 
     def rename_files
@@ -114,7 +115,7 @@ module SchemaDev
     def git_init
       Dir.chdir gem_name do 
         system "git init"
-        system "git add #{gem_root.find.select(&:exist?).join(' ')}"
+        system "git add #{gem_root.find.select(&:exist?).reject(&it.basename.to_s == 'Gemfile.local').join(' ')}"
         system "git commit -m 'Initial skeleton generated by `schema_dev gem #{gem_name}`'"
       end
     end

data/lib/schema_dev/readme.rb

@@ -17,30 +17,53 @@ module SchemaDev
       return false unless readme.exist?
       lines = readme.readlines
       newlines = sub_matrix(lines)
+      newlines = sub_templates(newlines)
       if lines != newlines
-        readme.write newlines.join
+        readme.write Gem.new(Pathname.pwd.basename.to_s).subs(newlines.join)
         return true
       end
     end
 
     def sub_matrix(lines)
-      pattern = %r{^\s*<!-- SCHEMA_DEV: MATRIX}
-      before = lines.take_while(&it !~ pattern)
+      replace_block(lines, %r{^\s*<!-- SCHEMA_DEV: MATRIX}) do |contents|
+        contents << "<!-- SCHEMA_DEV: MATRIX - begin -->\n"
+        contents << "<!-- These lines are auto-generated by schema_dev based on schema_dev.yml -->\n"
+        self.matrix.group_by(&it.slice(:ruby, :activerecord)).each do |pair, items|
+          contents << "* ruby **#{pair[:ruby]}** with activerecord **#{pair[:activerecord]}**, using #{items.map{|item| "**#{item[:db]}**"}.to_sentence(last_word_connector: ' or ')}\n"
+        end
+        contents << "\n"
+        contents << "<!-- SCHEMA_DEV: MATRIX - end -->\n"
+      end
+    end
 
-      return lines if before == lines
+    def sub_templates(lines)
+      Pathname.glob(SchemaDev::Templates.root + "README" + "*.md").each do |template|
+        lines = sub_template(template, lines)
+      end
+      lines
+    end
 
-      after = lines.reverse.take_while(&it !~ pattern).reverse
+    def sub_template(template, lines)
+      key = template.basename.sub_ext('').to_s.upcase.tr('.', ' ')
 
-      contents = []
-      contents << "<!-- SCHEMA_DEV: MATRIX - begin -->\n"
-      contents << "<!-- These lines are auto-generated by schema_dev based on schema_dev.yml -->\n"
-      self.matrix.group_by(&it.slice(:ruby, :activerecord)).each do |pair, items|
-        contents << "* ruby **#{pair[:ruby]}** with activerecord **#{pair[:activerecord]}**, using #{items.map{|item| "**#{item[:db]}**"}.to_sentence(last_word_connector: ' or ')}\n"
+      replace_block(lines, %r{^\s*<!-- SCHEMA_DEV: TEMPLATE #{key}}) do |contents|
+        contents << "<!-- SCHEMA_DEV: TEMPLATE #{key} - begin -->\n"
+        contents << "<!-- These lines are auto-inserted from a schema_dev template -->\n"
+        contents << template.readlines
+        contents << "\n"
+        contents << "<!-- SCHEMA_DEV: TEMPLATE #{key} - end -->\n"
       end
-      contents << "\n"
-      contents << "<!-- SCHEMA_DEV: MATRIX - end -->\n"
+    end
 
+    def replace_block(lines, pattern)
+      before = lines.take_while(&it !~ pattern)
+      return lines if before == lines
+      after = lines.reverse.take_while(&it !~ pattern).reverse
+      contents = []
+      yield contents
       before + contents + after
     end
+
+
   end
 end

data/lib/schema_dev/rspec/db.rb

@@ -30,12 +30,17 @@ module SchemaDev
         @logroot ||= Pathname.new('log').tap { |path| path.mkpath }
       end
 
+      def database
+        @database ||= "schema_plus_test"
+        # @database ||= (Dir["*.gemspec"].first || "schema_dev_test").sub(/\.gemspec$/, '') + "_test"
+      end
+
       def configuration
         case @db
         when 'mysql'
           {
             :adapter => 'mysql',
-            :database => 'schema_plus_test',
+            :database => database,
             :username => ENV.fetch('MYSQL_DB_USER', 'schema_plus'),
             :encoding => 'utf8',
             :min_messages => 'warning'
@@ -43,7 +48,7 @@ module SchemaDev
         when 'mysql2'
           {
             :adapter => 'mysql2',
-            :database => 'schema_plus_test',
+            :database => database,
             :username => ENV.fetch('MYSQL_DB_USER', 'schema_plus'),
             :encoding => 'utf8',
             :min_messages => 'warning'
@@ -52,13 +57,13 @@ module SchemaDev
           {
             :adapter => 'postgresql',
             :username => ENV['POSTGRESQL_DB_USER'],
-            :database => 'schema_plus_test',
+            :database => database,
             :min_messages => 'warning'
           }
         when 'sqlite3'
           {
             :adapter => 'sqlite3',
-            :database => tmproot.join('schema_plus.sqlite3').to_s
+            :database => tmproot.join("#{database}.sqlite3").to_s
           }
         else
           raise "Unknown db adapter #{@db.inspect}"

data/lib/schema_dev/version.rb

@@ -1,3 +1,3 @@
 module SchemaDev
-  VERSION = "3.0.1"
+  VERSION = "3.1.0"
 end

data/templates/README/installation.md

@@ -0,0 +1,14 @@
+As usual:
+
+```ruby
+gem "%GEM_NAME%"                # in a Gemfile
+gem.add_dependency "%GEM_NAME%" # in a .gemspec
+```
+
+To use with a rails app, also include
+
+```ruby
+gem "schema_monkey_rails"
+```
+
+which creates a Railtie to that will insert %GEM_MODULE% appropriately into the rails stack. To use with Padrino, see [schema_monkey_padrino](https://github.com/SchemaPlus/schema_monkey_padrino).

data/templates/README/uses.schema_dev.md

@@ -0,0 +1,15 @@
+* **schema_dev**:  %GEM_MODULE% uses [schema_dev](https://github.com/SchemaPlus/schema_dev) to
+  facilitate running rspec tests on the matrix of ruby, activerecord, and database
+  versions that the gem supports, both locally and on
+  [travis-ci](http://travis-ci.org/SchemaPlus/%GEM_NAME%)
+
+  To to run rspec locally on the full matrix, do:
+
+        $ schema_dev bundle install
+        $ schema_dev rspec
+
+  You can also run on just one configuration at a time;  For info, see `schema_dev --help` or the [schema_dev](https://github.com/SchemaPlus/schema_dev) README.
+
+  The matrix of configurations is specified in `schema_dev.yml` in
+  the project root.
+

data/templates/README/uses.schema_monkey.md

@@ -0,0 +1,5 @@
+* **schema_monkey**: %GEM_MODULE% is implemented as a
+  [schema_monkey](https://github.com/SchemaPlus/schema_monkey) client,
+  using [schema_monkey](https://github.com/SchemaPlus/schema_monkey)'s
+  convention-based protocols for extending ActiveRecord and using middleware stacks.
+  For more information see [schema_monkey](https://github.com/SchemaPlus/schema_monkey)'s README.

data/templates/README/uses.schema_plus_core.md

@@ -0,0 +1,6 @@
+* **schema_plus_core**: %GEM_MODULE% uses the SchemaPlus::Core API that
+  provides middleware callback stacks to make it easy to extend
+  ActiveRecord's behavior.  If that API is missing something you need for
+  your contribution, please head over to
+  [schema_plus_core](https://github/SchemaPlus/schema_plus_core) and open
+  an issue or pull request.  

data/templates/gem/GEM_NAME.gemspec

@@ -3,28 +3,28 @@ lib = File.expand_path('../lib', __FILE__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 require '%GEM_NAME%/version'
 
-Gem::Specification.new do |spec|
-  spec.name          = "%GEM_NAME%"
-  spec.version       = %GEM_MODULE%::VERSION
-  spec.authors       = ["%FULLNAME%"]
-  spec.email         = ["%EMAIL%"]
-  spec.summary       = %q{TODO: Write a short summary. Required.}
-  spec.description   = %q{TODO: Write a longer description. Optional.}
-  spec.homepage      = "https://github.com/SchemaPlus/%GEM_NAME%"
-  spec.license       = "MIT"
+Gem::Specification.new do |gem|
+  gem.name          = "%GEM_NAME%"
+  gem.version       = %GEM_MODULE%::VERSION
+  gem.authors       = ["%FULLNAME%"]
+  gem.email         = ["%EMAIL%"]
+  gem.summary       = %q{TODO: Write a short summary. Required.}
+  gem.description   = %q{TODO: Write a longer description. Optional.}
+  gem.homepage      = "https://github.com/SchemaPlus/%GEM_NAME%"
+  gem.license       = "MIT"
 
-  spec.files         = `git ls-files -z`.split("\x0")
-  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
-  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
-  spec.require_paths = ["lib"]
+  gem.files         = `git ls-files -z`.split("\x0")
+  gem.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  gem.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  gem.require_paths = ["lib"]
 
-  spec.add_dependency "activerecord", "~> 4.2"
-  spec.add_dependency "schema_monkey", %SCHEMA_MONKEY_DEPENDENCY%
+  gem.add_dependency "activerecord", "~> 4.2"
+  gem.add_dependency "schema_monkey", %SCHEMA_MONKEY_DEPENDENCY%
 
-  spec.add_development_dependency "bundler", "~> 1.7"
-  spec.add_development_dependency "rake", "~> 10.0"
-  spec.add_development_dependency "rspec", "~> 3.0.0"
-  spec.add_development_dependency "schema_dev", %SCHEMA_DEV_DEPENDENCY%
-  spec.add_development_dependency "simplecov"
-  spec.add_development_dependency "simplecov-gem-profile"
+  gem.add_development_dependency "bundler", "~> 1.7"
+  gem.add_development_dependency "rake", "~> 10.0"
+  gem.add_development_dependency "rspec", "~> 3.0.0"
+  gem.add_development_dependency "schema_dev", %SCHEMA_DEV_DEPENDENCY%
+  gem.add_development_dependency "simplecov"
+  gem.add_development_dependency "simplecov-gem-profile"
 end

data/templates/gem/Gemfile.local

@@ -0,0 +1,10 @@
+# Gemfile.local
+#
+# Gems for local development, .gitignore'd to not include in released gem
+#
+
+# For path-relative gems (because Gemfile.local gets included from Gemfiles
+# in subdirectories, the actual system cwd may be elsewhere)
+cwd = Pathname.new(__FILE__).dirname 
+
+gem "byebug"

data/templates/gem/README.md

@@ -11,11 +11,8 @@ TODO: Write a gem description
 
 ## Installation
 
-In your application's Gemfile
+<!-- SCHEMA_DEV: TEMPLATE INSTALLATION -->
 
-```ruby
-gem "%GEM_NAME%"
-```
 ## Compatibility
 
 %GEM_MODULE% is tested on:
@@ -28,28 +25,18 @@ TODO: Write usage instructions here
 
 ## History
 
-*   See [CHANGELOG](CHANGELOG.md) for per-version release notes.
+* 0.1.0 - Initial release
 
 ## Development & Testing
 
-Are you interested in contributing to %GEM_MODULE%?  Thanks!  Please follow the standard protocol: fork, feature branch, develop, push, and issue pull request.
+Are you interested in contributing to %GEM_MODULE%?  Thanks!  Please follow
+the standard protocol: fork, feature branch, develop, push, and issue pull
+request.
 
 Some things to know about to help you develop and test:
 
-* **schema_dev**:  %GEM_MODULE% uses [schema_dev](https://github.com/SchemaPlus/schema_dev) to
-  facilitate running rspec tests on the matrix of ruby, activerecord, and database
-  versions that the gem supports, both locally and on
-  [travis-ci](http://travis-ci.org/SchemaPlus/%GEM_NAME%)
+<!-- SCHEMA_DEV: TEMPLATE USES SCHEMA_DEV -->
 
-  To to run rspec locally on the full matrix, do:
+<!-- SCHEMA_DEV: TEMPLATE USES SHEMA_PLUS_CORE -->
 
-        $ schema_dev bundle install
-        $ schema_dev rspec
-
-  You can also run on just one configuration at a time;  For info, see `schema_dev --help` or the [schema_dev](https://github.com/SchemaPlus/schema_dev) README.
-
-  The matrix of configurations is specified in `schema_dev.yml` in
-  the project root.
-
-* **schema_monkey**: %GEM_MODULE% extends ActiveRecord using
-  [schema_monkey](https://github.com/SchemaPlus/schema_monkey)'s extension API and protocols -- see its README for details.  If your contribution needs any additional monkey patching that isn't already supported by [schema_monkey](https://github.com/SchemaPlus/schema_monkey), please head over there and submit a PR.
+<!-- SCHEMA_DEV: TEMPLATE USES SHEMA_MONKEY -->

data/templates/gem/schema_dev.yml

@@ -1,5 +1,4 @@
 ruby:
-    - 1.9.3
     - 2.1.5
 activerecord:
     - 4.2

data/templates/gemfiles/Gemfile.base

@@ -1,8 +1,4 @@
 source 'https://rubygems.org'
 gemspec :path => File.expand_path('..', __FILE__)
 
-platform :ruby do
-    gem "byebug" if RUBY_VERSION > "2"
-end
-
 File.exist?(gemfile_local = File.expand_path('../Gemfile.local', __FILE__)) and eval File.read(gemfile_local), binding, gemfile_local

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: schema_dev
 version: !ruby/object:Gem::Version
-  version: 3.0.1
+  version: 3.1.0
 platform: ruby
 authors:
 - ronen barzel
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-02-01 00:00:00.000000000 Z
+date: 2015-02-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -234,12 +234,17 @@ files:
 - spec/runner_spec.rb
 - spec/spec_helper.rb
 - spec/travis_spec.rb
-- templates/gem/.gitignore
+- templates/README/installation.md
+- templates/README/uses.schema_dev.md
+- templates/README/uses.schema_monkey.md
+- templates/README/uses.schema_plus_core.md
 - templates/gem/GEM_NAME.gemspec
 - templates/gem/Gemfile
+- templates/gem/Gemfile.local
 - templates/gem/LICENSE.txt
 - templates/gem/README.md
 - templates/gem/Rakefile
+- templates/gem/gitignore
 - templates/gem/lib/GEM_NAME.rb
 - templates/gem/lib/GEM_NAME/version.rb
 - templates/gem/schema_dev.yml