jasmine_fixture_builder 0.0.1 → 0.1.0

data/.codeclimate.yml

@@ -0,0 +1,2 @@
+languages:
+  Ruby: true

data/.gitignore

@@ -7,3 +7,5 @@
 /pkg/
 /spec/reports/
 /tmp/
+
+jasmine_fixture_builder-*.gem

data/.travis.yml

@@ -1,3 +1,7 @@
 language: ruby
+
+cache: bundler
+
 rvm:
-  - 2.1.6
+  - 2.2.2
+

data/CHANGELOG.md

@@ -0,0 +1,7 @@
+### 0.1.0 - January 20, 2017
+- Add support for rspec-rails 3.5.
+- Create the fixture directory if it does not exist.
+- Update dependency, README, and usage instructions.
+
+### 0.0.1 - June 2015
+- Initial release.

data/README.md

@@ -1,23 +1,74 @@
+[![Build Status](https://travis-ci.org/defmethodinc/jasmine-fixture-builder.svg?branch=master)](https://travis-ci.org/defmethodinc/jasmine-fixture-builder)
+[![Code Climate](https://codeclimate.com/github/defmethodinc/jasmine-fixture-builder/badges/gpa.svg)](https://codeclimate.com/github/defmethodinc/jasmine-fixture-builder)
+[![Test Coverage](https://codeclimate.com/github/defmethodinc/jasmine-fixture-builder/badges/coverage.svg)](https://codeclimate.com/github/defmethodinc/jasmine-fixture-builder/coverage)
 # Jasmine Fixture Builder
 
 Jasmine Fixture Builder (or "JazzFix" for short) allows you to generate fixtures for your jasmine specs based on the DOM your application renders. Don't let your jasmine fixtures get stale and lie to you - use JazzFix to keep your application's DOM and jasmine specs in sync!
 
+## Dependencies
+
+JazzFix works alongside the use of the following:
+- rails
+- jquery
+- rspec-rails
+- jasmine
+- jasmine-jquery
+
 JazzFix leverages the fixture loading ability of [jasmine-jquery](https://github.com/velesin/jasmine-jquery) along with the clean DOM rendering that [rspec-rails](https://github.com/rspec/rspec-rails) [view specs](https://github.com/rspec/rspec-rails#view-specs) provide. JazzFix owes a debt of gratitude to the work and subsequent [experience report](http://pivotallabs.com/javascriptspecs-bind-reality/) from JB Steadman.
 
 ## Installation
 
-Add this line to your application's Gemfile:
+Add the following gems to application's gem file, grouped to development/test:
+ - jasmine
+ - jasmine-jquery-rails
+ - jasmine_fixture_builder
 
-```ruby
-gem 'jasmine_fixture_builder'
-```
+(rspec-rails is a dependency of jasmine_fixture_builder, so there is no need to explicitly add it to your gem file as a dependency)
 
-And then execute:
+Run the following:
+- `bundle install`
+- `rails generate rspec:install`
+- `rails generate jasmine:install`
 
-    $ bundle
+Add `assets/jasmine-jquery.js` underneath the `src_files` item in your jasmine.yml, which should live in the spec/javascripts/support directory.
 
 ## Usage
 
+###Create a fixture with RSpec:
+
+Create a [view spec](https://www.relishapp.com/rspec/rspec-rails/v/3-5/docs/view-specs/view-spec) for a particular view you want to create a fixture from. Render the view, then save the rendered html to a fixture with the provided `save_fixture` method:
+
+```
+describe 'widgets/index' do
+	it 'creates fixture' do
+		render
+		save_fixture(rendered, 'widgets_index.html')
+	end
+end
+```
+`save_fixture` takes 2 arguments: the markup as its first, the name to ascribe the fixture to as its second.
+
+This saves the markup from the view into a file living at `spec/javascripts/fixtures/widgets_index.html`.
+
+###Use that fixture in your Jasmine test:
+
+Utilize the `loadFixture` method from jasmine-jquery to load up the fixture for use in your test.  `loadFixture` inserts the markup from your fixture into a container `<div id='jasmine-fixtures'></div>`.
+
+```
+describe('widgets/index', function() {
+	it('tests javascript action', function() {
+		//load the fixture
+		loadFixture('widgets_index.html');
+
+		// test some javascript action
+		$('#jasmine-fixtures .some-button').click();
+
+		// make an assertion
+		$('#jasmine-fixtures .some-container').toHaveText('text');
+	});
+});
+```
+
 ## Development
 
 After checking out the repo, run `bin/setup` to install dependencies. Then, run `bin/console` for an interactive prompt that will allow you to experiment.

data/Rakefile

@@ -1 +1,10 @@
 require "bundler/gem_tasks"
+
+task :default => [:spec]
+
+begin
+  require 'rspec/core/rake_task'
+  RSpec::Core::RakeTask.new(:spec)
+rescue LoadError
+end
+

data/jasmine_fixture_builder.gemspec

@@ -20,7 +20,9 @@ Gem::Specification.new do |spec|
 
   spec.add_development_dependency "bundler", "~> 1.9"
   spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "railties"
+  spec.add_development_dependency "pry", "~> 0.10.1"
+  spec.add_development_dependency "codeclimate-test-reporter", "~> 0.4.7"
 
-  spec.add_dependency 'rspec-rails'
+  spec.add_dependency "rspec-rails", [">= 3.0", "< 3.6"]
 end
-

data/lib/jasmine_fixture_builder/fixture_writer.rb

@@ -0,0 +1,27 @@
+require 'fileutils'
+require 'rails'
+
+module JasmineFixtureBuilder
+  class FixtureWriter
+
+    def initialize(markup, fixture_name)
+      @markup = markup
+      @fixture_name = fixture_name
+    end
+
+    def write
+      fixture_file = File.join(fixture_path, @fixture_name)
+      FileUtils.mkdir_p(fixture_path) unless File.directory?(fixture_path)
+      File.open(fixture_file, 'w') do |file|
+        file.puts(@markup)
+      end
+    end
+
+    private
+
+    def fixture_path
+      @fixture_path ||= Rails.root.join(JAZZ_FIX_PATHS[:fixture_path])
+    end
+  end
+end
+

data/lib/jasmine_fixture_builder/path_installer.rb

@@ -0,0 +1,14 @@
+module JasmineFixtureBuilder
+  class PathInstaller
+    def self.install(root_path)
+      JAZZ_FIX_PATHS.values.each do |jazz_fix_path|
+        install_path = root_path.join(jazz_fix_path)
+        unless Dir.exists?(install_path)
+          FileUtils.mkdir_p(install_path)
+          File.new(install_path.to_s + "/.keep", "w")
+        end
+      end
+    end
+  end
+end
+

data/lib/jasmine_fixture_builder/railtie.rb

@@ -0,0 +1,9 @@
+module JasmineFixtureBuilder
+  class Railtie < Rails::Railtie
+
+    rake_tasks do
+      require "jasmine_fixture_builder/tasks"
+    end
+  end
+end
+

data/lib/jasmine_fixture_builder/rspec_matchers.rb

@@ -0,0 +1,11 @@
+require "rspec/expectations"
+
+module JasmineFixtureBuilder
+  class RspecMatchers
+
+    RSpec::Matchers.define :save_fixture do |markup, fixture|
+      FixtureWriter.new(markup, fixture).write
+    end
+  end
+end
+

data/lib/jasmine_fixture_builder/tasks.rb

@@ -0,0 +1,9 @@
+require_relative "path_installer.rb"
+
+namespace :jazz_fix do
+  desc "Create directory structure for jasmine_fixture_builder"
+  task :install do
+    JasmineFixtureBuilder::PathInstaller.install(Rails.root)
+  end
+end
+

data/lib/jasmine_fixture_builder/version.rb

@@ -1,4 +1,4 @@
 module JasmineFixtureBuilder
-  VERSION = "0.0.1"
+  VERSION = "0.1.0"
 end
 

data/lib/jasmine_fixture_builder.rb

@@ -1,13 +1,14 @@
 require "jasmine_fixture_builder/version"
+require "jasmine_fixture_builder/path_installer"
+require "jasmine_fixture_builder/rspec_matchers"
+require "jasmine_fixture_builder/fixture_writer"
 
 module JasmineFixtureBuilder
-  RSpec::Matchers.define :save_fixture do |markup, fixture|
-    fixture_path = Rails.root.join('spec/javascripts/fixtures')
-    Dir.mkdir(fixture_path) unless File.exists?(fixture_path)
-    fixture_file = File.join(fixture_path, fixture)
-    File.open(fixture_file, 'w') do |file|
-      file.puts(markup)
-    end
-  end
+  JAZZ_FIX_PATHS = {
+    fixture_path: "spec/javascripts/fixtures",
+    fixture_builder_path: "spec/javascripts/fixture_builders"
+  }
+
+  require "jasmine_fixture_builder/railtie" if defined?(Rails)
 end
 

metadata

@@ -1,57 +1,118 @@
 --- !ruby/object:Gem::Specification
 name: jasmine_fixture_builder
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.1.0
+  prerelease: 
 platform: ruby
 authors:
 - jleo3
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2015-05-03 00:00:00.000000000 Z
+date: 2017-01-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
+    none: false
     requirements:
-    - - "~>"
+    - - ~>
       - !ruby/object:Gem::Version
         version: '1.9'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
+    none: false
     requirements:
-    - - "~>"
+    - - ~>
       - !ruby/object:Gem::Version
         version: '1.9'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
+    none: false
     requirements:
-    - - "~>"
+    - - ~>
       - !ruby/object:Gem::Version
         version: '10.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
+    none: false
     requirements:
-    - - "~>"
+    - - ~>
       - !ruby/object:Gem::Version
         version: '10.0'
 - !ruby/object:Gem::Dependency
-  name: rspec-rails
+  name: railties
   requirement: !ruby/object:Gem::Requirement
+    none: false
     requirements:
-    - - ">="
+    - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
-  type: :runtime
+  type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
+    none: false
     requirements:
-    - - ">="
+    - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.10.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.10.1
+- !ruby/object:Gem::Dependency
+  name: codeclimate-test-reporter
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.4.7
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.4.7
+- !ruby/object:Gem::Dependency
+  name: rspec-rails
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '3.0'
+    - - <
+      - !ruby/object:Gem::Version
+        version: '3.6'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '3.0'
+    - - <
+      - !ruby/object:Gem::Version
+        version: '3.6'
 description: 
 email:
 - joe@defmethod.com
@@ -59,9 +120,11 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- ".gitignore"
-- ".rspec"
-- ".travis.yml"
+- .codeclimate.yml
+- .gitignore
+- .rspec
+- .travis.yml
+- CHANGELOG.md
 - CODE_OF_CONDUCT.md
 - Gemfile
 - LICENSE.txt
@@ -71,29 +134,35 @@ files:
 - bin/setup
 - jasmine_fixture_builder.gemspec
 - lib/jasmine_fixture_builder.rb
+- lib/jasmine_fixture_builder/fixture_writer.rb
+- lib/jasmine_fixture_builder/path_installer.rb
+- lib/jasmine_fixture_builder/railtie.rb
+- lib/jasmine_fixture_builder/rspec_matchers.rb
+- lib/jasmine_fixture_builder/tasks.rb
 - lib/jasmine_fixture_builder/version.rb
 homepage: ''
 licenses:
 - MIT
-metadata: {}
 post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
   requirements:
-  - - ">="
+  - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
   requirements:
-  - - ">="
+  - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.2.3
+rubygems_version: 1.8.23
 signing_key: 
-specification_version: 4
+specification_version: 3
 summary: Generates fixtures for Jasmine specs.
 test_files: []

checksums.yaml

@@ -1,7 +0,0 @@
----
-SHA1:
-  metadata.gz: a72f4efd3c02127de0f0329a8b6019707a3b4daa
-  data.tar.gz: f5024217daa1c0d6e41ab34d261fd44d32e83300
-SHA512:
-  metadata.gz: a96d38d84ff6e98cd7d4ae70bd18f4007e165e2c717a404edf4184881aeb05edc84cfcaf82620249937e4a963f8390303759f42085e80178c86c629a94908e35
-  data.tar.gz: 9b59843b4b65b69c5f5e0dd5d802b35bb5d012739790ff0a80e66e4a5a920a96987b8c2063d0f4508fa0c603af3a8e8a9ae6413e9a188ade1638552c24a48f79