textacular 3.2.0 → 3.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 3370755c291011043272f5b45c44d4c9d9ad8445
-  data.tar.gz: b0c0b7c22dd7c79b7a343af679ba5ab9cee2e817
+  metadata.gz: 4265ce68e4f181daae87f7bd5ddeafd3b6319b74
+  data.tar.gz: 01747846949f1a3ceef279a62f1e4587cea23a7a
 SHA512:
-  metadata.gz: 9d426b395d05e45de9ac1341f7b19ae3cf35533801e2c62dba488c221c15e0a78602e4ee349f720186701dc39586899671508068f837bfdf0852a7012c9475dc
-  data.tar.gz: 031698a4ae0185a3e73fd4a191f04e1a497258958378056469228e826f28b138d0aaa5b182b209841322c47fa803f31824d2751a2b13feebb86f1e361c1f76c5
+  metadata.gz: 9cd720c7b946da4ec997dff477eae5ccc4133a086784bdd1a9521ba53c5b0683698c5daa6d445acf48b9eb600bfe2d805a60a5410ddcdaac7fd22259ad0040d2
+  data.tar.gz: 5978ac5a4a59eeaf656b09dcadb36f0034e8e9190d5d8c800e5525471b738c9fde8187676a130d0c2e9ebd160cbe9b448b808b16e3a1a3b5d10201df54ea0164

data/CHANGELOG.md

@@ -1,5 +1,10 @@
 # Change Log
 
+## Unreleased
+
+* Fix trigram installation migration reversed filename and content.
+* Rewrite all tests using RSpec.
+
 ## 3.2.0
 
 * Add generator for trigram installation migration.

data/README.md

@@ -1,5 +1,11 @@
-[![Build Status](https://travis-ci.org/textacular/textacular.png)](https://travis-ci.org/textacular/textacular) [![Code Climate](https://codeclimate.com/github/textacular/textacular.png)](https://codeclimate.com/github/textacular/textacular)
 # textacular
+[![Gem Version](http://img.shields.io/gem/v/textacular.svg)][rubygems]
+[![Build Status](https://img.shields.io/travis/textacular/textacular/master.svg)][travis]
+[![Code Climate](https://img.shields.io/codeclimate/github/textacular/textacular.svg)][codeclimate]
+
+[rubygems]: http://rubygems.org/gems/textacular
+[travis]: https://travis-ci.org/textacular/textacular
+[codeclimate]: https://codeclimate.com/github/textacular/textacular
 
 Further documentation available at http://textacular.github.com/textacular.
 

data/Rakefile

@@ -1,14 +1,13 @@
 require "bundler/gem_tasks"
 
 require 'active_record'
-require 'rake/testtask'
 require 'pry'
 
-Rake::TestTask.new do |t|
-  t.libs << 'spec'
-  t.test_files = FileList[ 'spec/**/*_spec.rb' ]
-end
-task :default => :test
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec
 
 file 'spec/config.yml' do |t|
   sh 'erb spec/config.yml.example > spec/config.yml'

data/lib/textacular/trigram_installer.rb

@@ -12,7 +12,7 @@ class InstallTrigram < ActiveRecord::Migration
 end
 MIGRATION
     filename = "install_trigram"
-    generator = Textacular::MigrationGenerator.new(content, filename)
+    generator = Textacular::MigrationGenerator.new(filename, content)
     generator.generate_migration
   end
 end

data/lib/textacular/version.rb

@@ -1,5 +1,5 @@
 module Textacular
-  VERSION = '3.2.0'
+  VERSION = '3.2.1'
 
   def self.version
     VERSION

data/spec/config.travis.yml

@@ -0,0 +1,8 @@
+pool: 5
+timeout: 5000
+host: localhost
+adapter: postgresql
+username: postgres
+password:
+database: textacular_test
+min_messages: ERROR

data/spec/spec_helper.rb

@@ -1,78 +1,104 @@
-require 'bundler/setup'
-require 'yaml'
-require 'textacular'
-require 'shoulda'
 require 'pry'
-require 'active_record'
 require 'textacular'
-require 'textacular/searchable'
-require 'flexmock/test_unit'
+require 'database_cleaner'
+require 'yaml'
 
 config = YAML.load_file File.expand_path(File.dirname(__FILE__) + '/config.yml')
 ActiveRecord::Base.establish_connection config.merge(:adapter => :postgresql)
 
-class ARStandIn < ActiveRecord::Base;
-  self.abstract_class = true
-  extend Textacular
-end
-
-class NotThere < ARStandIn; end
-
-class TextacularWebComic < ARStandIn;
-  has_many :characters, :foreign_key => :web_comic_id
-  self.table_name = :web_comics
-end
-
-
-class WebComic < ActiveRecord::Base
-  # string :name
-  # string :author
-  # integer :id
-
-  has_many :characters
-end
-
-class WebComicWithSearchable < WebComic
-  extend Searchable
-end
-
-class WebComicWithSearchableName < WebComic
-  extend Searchable(:name)
-end
-
-class WebComicWithSearchableNameAndAuthor < WebComic
-  extend Searchable(:name, :author)
-end
-
-
-class Character < ActiveRecord::Base
-  # string :name
-  # string :description
-  # integer :web_comic_id
-
-  belongs_to :web_comic
-end
-
-
-class Game < ActiveRecord::Base
-  # string :system
-  # string :title
-  # text :description
-end
-
-class GameExtendedWithTextacular < Game
-  extend Textacular
-end
-
-class GameExtendedWithTextacularAndCustomLanguage < GameExtendedWithTextacular
-  def searchable_language
-    'spanish'
+# This file was generated by the `rspec --init` command. Conventionally, all
+# specs live under a `spec` directory, which RSpec adds to the `$LOAD_PATH`.
+# The generated `.rspec` file contains `--require spec_helper` which will cause this
+# file to always be loaded, without a need to explicitly require it in any files.
+#
+# Given that it is always loaded, you are encouraged to keep this file as
+# light-weight as possible. Requiring heavyweight dependencies from this file
+# will add to the boot time of your test suite on EVERY test run, even for an
+# individual file that may not need all of that loaded. Instead, consider making
+# a separate helper file that requires the additional dependencies and performs
+# the additional setup, and require it from the spec files that actually need it.
+#
+# The `.rspec` file also contains a few flags that are not defaults but that
+# users commonly want.
+#
+# See http://rubydoc.info/gems/rspec-core/RSpec/Core/Configuration
+RSpec.configure do |config|
+  # rspec-expectations config goes here. You can use an alternate
+  # assertion/expectation library such as wrong or the stdlib/minitest
+  # assertions if you prefer.
+  config.expect_with :rspec do |expectations|
+    # This option will default to `true` in RSpec 4. It makes the `description`
+    # and `failure_message` of custom matchers include text for helper methods
+    # defined using `chain`, e.g.:
+    # be_bigger_than(2).and_smaller_than(4).description
+    #   # => "be bigger than 2 and smaller than 4"
+    # ...rather than:
+    #   # => "be bigger than 2"
+    expectations.include_chain_clauses_in_custom_matcher_descriptions = true
   end
-end
 
+  # rspec-mocks config goes here. You can use an alternate test double
+  # library (such as bogus or mocha) by changing the `mock_with` option here.
+  config.mock_with :rspec do |mocks|
+    # Prevents you from mocking or stubbing a method that does not exist on
+    # a real object. This is generally recommended, and will default to
+    # `true` in RSpec 4.
+    mocks.verify_partial_doubles = true
+  end
 
-class GameFail < Game; end
+  # These two settings work together to allow you to limit a spec run
+  # to individual examples or groups you care about by tagging them with
+  # `:focus` metadata. When nothing is tagged with `:focus`, all examples
+  # get run.
+  config.filter_run :focus
+  config.run_all_when_everything_filtered = true
+
+  # Limits the available syntax to the non-monkey patched syntax that is recommended.
+  # For more details, see:
+  #   - http://myronmars.to/n/dev-blog/2012/06/rspecs-new-expectation-syntax
+  #   - http://teaisaweso.me/blog/2013/05/27/rspecs-new-message-expectation-syntax/
+  #   - http://myronmars.to/n/dev-blog/2014/05/notable-changes-in-rspec-3#new__config_option_to_disable_rspeccore_monkey_patching
+  config.disable_monkey_patching!
+
+  # This setting enables warnings. It's recommended, but in some cases may
+  # be too noisy due to issues in dependencies.
+  config.warnings = true
+
+  # Many RSpec users commonly either run the entire suite or an individual
+  # file, and it's useful to allow more verbose output when running an
+  # individual spec file.
+  # if config.files_to_run.one?
+    # Use the documentation formatter for detailed output,
+    # unless a formatter has already been configured
+    # (e.g. via a command-line flag).
+    # config.default_formatter = 'doc'
+  # end
+
+  # Print the 10 slowest examples and example groups at the
+  # end of the spec run, to help surface which specs are running
+  # particularly slow.
+  # config.profile_examples = 10
+
+  # Run specs in random order to surface order dependencies. If you find an
+  # order dependency and want to debug it, you can fix the order by providing
+  # the seed, which is printed after each run.
+  #     --seed 1234
+  config.order = :random
+
+  # Seed global randomization in this process using the `--seed` CLI option.
+  # Setting this allows you to use `--seed` to deterministically reproduce
+  # test failures related to randomization by passing the same `--seed` value
+  # as the one that triggered the failure.
+  Kernel.srand config.seed
+
+  config.before(:suite) do
+    DatabaseCleaner.strategy = :transaction
+    DatabaseCleaner.clean_with(:truncation)
+  end
 
-class GameFailExtendedWithTextacular < GameFail
-  extend Textacular
+  config.around(:each) do |example|
+    DatabaseCleaner.cleaning do
+      example.run
+    end
+  end
 end

data/spec/support/ar_stand_in.rb

@@ -0,0 +1,4 @@
+class ARStandIn < ActiveRecord::Base;
+  self.abstract_class = true
+  extend Textacular
+end

data/spec/{fixtures → support}/character.rb

@@ -2,5 +2,6 @@ class Character < ActiveRecord::Base
   # string :name
   # string :description
   # integer :web_comic_id
+
   belongs_to :web_comic
 end

data/spec/{fixtures → support}/game.rb

@@ -3,5 +3,3 @@ class Game < ActiveRecord::Base
   # string :title
   # text :description
 end
-
-class GameFail < Game; end

data/spec/support/game_extended_with_textacular.rb

@@ -0,0 +1,5 @@
+require 'support/game'
+
+class GameExtendedWithTextacular < Game
+  extend Textacular
+end

data/spec/support/game_extended_with_textacular_and_custom_language.rb

@@ -0,0 +1,7 @@
+require 'support/game_extended_with_textacular'
+
+class GameExtendedWithTextacularAndCustomLanguage < GameExtendedWithTextacular
+  def searchable_language
+    'spanish'
+  end
+end

data/spec/support/game_fail.rb

@@ -0,0 +1,3 @@
+require 'support/game'
+
+class GameFail < Game; end

data/spec/support/game_fail_extended_with_textacular.rb

@@ -0,0 +1,5 @@
+require 'support/game_fail'
+
+class GameFailExtendedWithTextacular < GameFail
+  extend Textacular
+end

data/spec/support/not_there.rb

@@ -0,0 +1,3 @@
+require 'support/ar_stand_in'
+
+class NotThere < ARStandIn; end

data/spec/support/textacular_web_comic.rb

@@ -0,0 +1,7 @@
+require 'support/ar_stand_in'
+require 'support/character'
+
+class TextacularWebComic < ARStandIn;
+  has_many :characters, :foreign_key => :web_comic_id
+  self.table_name = :web_comics
+end

data/spec/support/web_comic_with_searchable.rb

@@ -0,0 +1,6 @@
+require 'textacular/searchable'
+require 'support/web_comic'
+
+class WebComicWithSearchable < WebComic
+  extend Searchable
+end

data/spec/support/web_comic_with_searchable_name.rb

@@ -0,0 +1,6 @@
+require 'textacular/searchable'
+require 'support/web_comic'
+
+class WebComicWithSearchableName < WebComic
+  extend Searchable(:name)
+end

data/spec/support/web_comic_with_searchable_name_and_author.rb

@@ -0,0 +1,6 @@
+require 'textacular/searchable'
+require 'support/web_comic'
+
+class WebComicWithSearchableNameAndAuthor < WebComic
+  extend Searchable(:name, :author)
+end

data/spec/textacular/full_text_indexer_spec.rb

@@ -0,0 +1,69 @@
+require 'support/web_comic_with_searchable_name'
+require 'support/web_comic_with_searchable_name_and_author'
+
+RSpec.describe Textacular::FullTextIndexer do
+  context "with one specific field in a Searchable call" do
+    it "generates the right SQL" do
+      file_name = "web_comic_with_searchable_name_full_text_search"
+      content = <<-MIGRATION
+class WebComicWithSearchableNameFullTextSearch < ActiveRecord::Migration
+  def self.up
+    execute(<<-SQL.strip)
+      DROP index IF EXISTS web_comics_name_fts_idx;
+      CREATE index web_comics_name_fts_idx
+        ON web_comics
+        USING gin(to_tsvector("english", "web_comics"."name"::text));
+    SQL
+  end
+
+  def self.down
+    execute(<<-SQL.strip)
+      DROP index IF EXISTS web_comics_name_fts_idx;
+    SQL
+  end
+end
+MIGRATION
+
+      generator = double(:migration_generator)
+      expect(Textacular::MigrationGenerator).to receive(:new).with(content, file_name).and_return(generator)
+      expect(generator).to receive(:generate_migration)
+
+      Textacular::FullTextIndexer.new.generate_migration('WebComicWithSearchableName')
+    end
+  end
+
+  context "with two specific fields in a Searchable call" do
+    it "generates the right SQL" do
+      file_name = "web_comic_with_searchable_name_and_author_full_text_search"
+      content = <<-MIGRATION
+class WebComicWithSearchableNameAndAuthorFullTextSearch < ActiveRecord::Migration
+  def self.up
+    execute(<<-SQL.strip)
+      DROP index IF EXISTS web_comics_name_fts_idx;
+      CREATE index web_comics_name_fts_idx
+        ON web_comics
+        USING gin(to_tsvector("english", "web_comics"."name"::text));
+      DROP index IF EXISTS web_comics_author_fts_idx;
+      CREATE index web_comics_author_fts_idx
+        ON web_comics
+        USING gin(to_tsvector("english", "web_comics"."author"::text));
+    SQL
+  end
+
+  def self.down
+    execute(<<-SQL.strip)
+      DROP index IF EXISTS web_comics_name_fts_idx;
+      DROP index IF EXISTS web_comics_author_fts_idx;
+    SQL
+  end
+end
+MIGRATION
+
+      generator = double(:migration_generator)
+      expect(Textacular::MigrationGenerator).to receive(:new).with(content, file_name).and_return(generator)
+      expect(generator).to receive(:generate_migration)
+
+      Textacular::FullTextIndexer.new.generate_migration('WebComicWithSearchableNameAndAuthor')
+    end
+  end
+end

data/spec/textacular/migration_generator_spec.rb

@@ -0,0 +1,67 @@
+RSpec.describe Textacular::MigrationGenerator do
+  describe ".stream_output" do
+    context "when Rails is not defined" do
+      subject do
+        Textacular::MigrationGenerator.new('filename', 'content')
+      end
+
+      it "points to STDOUT" do
+        output_stream = nil
+
+        subject.stream_output do |io|
+          output_stream = io
+        end
+
+        expect(output_stream).to eq(STDOUT)
+      end
+    end
+
+    context "when Rails is defined" do
+      before do
+        module ::Rails
+          # Stub this out, sort of.
+          def self.root
+            File.join('.', 'fake_rails')
+          end
+        end
+      end
+
+      after do
+        Object.send(:remove_const, :Rails)
+        FileUtils.rm_rf(File.join('.', 'fake_rails'))
+      end
+
+      let(:now) do
+        Time.now
+      end
+
+      subject do
+        Textacular::MigrationGenerator.new('file_name', 'content')
+      end
+
+      it "points to a properly names migration file" do
+        expected_file_name = "./fake_rails/db/migrate/#{now.strftime('%Y%m%d%H%M%S')}_file_name.rb"
+
+        output_stream = nil
+
+        subject.stream_output(now) do |io|
+          output_stream = io
+        end
+
+        expect(output_stream.path).to eq(expected_file_name)
+      end
+    end
+
+    it "generates the right SQL" do
+      content = "content\n" #newline automatically added
+      output = StringIO.new
+
+      generator = Textacular::MigrationGenerator.new('file_name', content)
+      generator.instance_variable_set(:@output_stream, output)
+
+      generator.generate_migration
+
+      expect(output.string).to eq(content)
+    end
+  end
+end