gemlock 0.2.2 → 0.2.3

data/lib/gemlock.rb

@@ -4,6 +4,7 @@ require "json"
 require "yaml"
 
 require "gemlock/version"
+require "gemlock/config"
 
 module Gemlock
   require 'gemlock/railtie' if defined?(Rails)
@@ -26,26 +27,6 @@ module Gemlock
       locked_gemfile_specs.delete_if { |spec| !gemfile_names.include?(spec.name) }
     end
 
-    def config
-      if defined?(Rails) && File.exists?(Rails.root.join('config', 'gemlock.yml'))
-        Rails.root.join('config', 'gemlock.yml')
-      end
-    end
-
-    def parsed_config
-      YAML.load_file(config) if config
-    end
-
-    def email
-      email = parsed_config['email'] if parsed_config
-
-      if email =~ /^[^@]+@[^@]+$/
-        email
-      else
-        nil
-      end
-    end
-
     def lookup_version(name)
       json_hash = JSON.parse(RestClient.get("http://gemlock.herokuapp.com/ruby_gems/#{name}/latest.json"))
 
@@ -59,16 +40,16 @@ module Gemlock
       end
 
       begin
-        types = if parsed_config
-                  parsed_config['releases']
+        types = if Config.parsed
+                  Config.parsed['releases']
                 else
                   nil
                 end
 
         params = {:gems => specs.to_json }
-        params[:types]     = types     if types
-        params[:automatic] = automatic if automatic
-        params[:email]     = email     if email
+        params[:types]     = types        if types
+        params[:automatic] = automatic    if automatic
+        params[:email]     = Config.email if Config.email
 
         response = RestClient.get("http://gemlock.herokuapp.com/ruby_gems/updates.json", :params => params)
         gems = JSON.parse(response)
@@ -100,7 +81,7 @@ module Gemlock
 
     # By default, check for updates every 2 weeks
     def initializer(automatic = true)
-      update_interval = Gemlock.update_interval
+      update_interval = Config.update_interval
       Thread.new(update_interval) do |interval|
         loop do
           puts "Checking for gem updates..."
@@ -123,32 +104,6 @@ module Gemlock
       end
     end
 
-    def update_interval
-      if parsed_config
-        if parsed_config["interval"]
-          interval = parsed_config["interval"][0]
-
-          num_hours = interval.match(/\d*/)[0].to_i
-          if interval =~ /hour/
-            delay = 60*60
-          elsif interval =~ /day/
-            delay = 60*60*24
-          elsif interval =~ /week/
-            delay = 60*60*24*7
-          elsif interval =~ /month/
-            delay = 60*60*24*30
-          end
-          if delay && num_hours > 0
-            delay *= num_hours
-            return delay
-          elsif delay
-            return delay
-          end
-        end
-      end
-      60*60*24*7 #Seconds in a week
-    end
-
     def check_gems_individually(gems)
       outdated = {}
 
@@ -156,7 +111,7 @@ module Gemlock
         latest_version = lookup_version(name)
         update_type = difference(version, latest_version)
         if Gem::Version.new(latest_version) > Gem::Version.new(version)
-          if parsed_config && parsed_config['releases'].include?(update_type)
+          if Config.parsed && Config.parsed['releases'].include?(update_type)
             outdated[name] = latest_version
           end
         end

data/lib/gemlock/config.rb

@@ -0,0 +1,51 @@
+module Gemlock
+  module Config
+    class << self
+      def file
+        if defined?(Rails) && File.exists?(Rails.root.join('config', 'gemlock.yml'))
+          Rails.root.join('config', 'gemlock.yml')
+        end
+      end
+
+      def parsed
+        parsed = YAML.load_file(file) if file
+      end
+
+      def email
+        email = parsed['email'] if parsed
+
+        if email =~ /^[^@]+@[^@]+$/
+          email
+        else
+          nil
+        end
+      end
+
+      def update_interval
+        if parsed
+          if parsed["interval"]
+            interval = parsed["interval"][0]
+
+            num_hours = interval.match(/\d*/)[0].to_i
+            if interval =~ /hour/
+              delay = 60*60
+            elsif interval =~ /day/
+              delay = 60*60*24
+            elsif interval =~ /week/
+              delay = 60*60*24*7
+            elsif interval =~ /month/
+              delay = 60*60*24*30
+            end
+            if delay && num_hours > 0
+              delay *= num_hours
+              return delay
+            elsif delay
+              return delay
+            end
+          end
+        end
+        60*60*24*7 #Seconds in a week
+      end
+    end
+  end
+end

data/lib/gemlock/version.rb

@@ -1,3 +1,3 @@
 module Gemlock
-  VERSION = "0.2.2"
+  VERSION = "0.2.3"
 end

data/lib/generators/gemlock/config_generator.rb

@@ -0,0 +1,12 @@
+require 'rails/generators'
+
+module Gemlock
+  class ConfigGenerator < Rails::Generators::Base
+    argument :email, :type => :string, :default => 'email@example.com'
+    source_root File.expand_path(File.join('..', '..', 'templates'), __FILE__)
+
+    def generate_config
+      template "config.yml.erb", "config/gemlock.yml"
+    end
+  end
+end

data/lib/generators/templates/config.yml.erb

@@ -0,0 +1,6 @@
+releases:
+  - major
+  - minor
+  - patch
+interval: 2 weeks
+email: <%= email %>

data/spec/gemlock/config_spec.rb

@@ -0,0 +1,95 @@
+require 'spec_helper'
+
+describe Gemlock::Config do
+  describe ".file" do
+    it "loads gemlock.yml from the config directory if Rails is defined" do
+      module Rails
+        def self.root
+          Pathname.new(File.dirname(__FILE__))
+        end
+      end
+      expected_path = Pathname.new(File.dirname(__FILE__)).join('config', 'gemlock.yml')
+      File.stubs(:exists?).with(expected_path).returns(true)
+
+      Gemlock::Config.file.should eql expected_path
+
+      # Undefine Rails module
+      Object.send(:remove_const, :Rails)
+
+    end
+
+    it "is nil if Rails is defined and the files does not exist" do
+      module Rails
+        def self.root
+          Pathname.new(File.dirname(__FILE__))
+        end
+      end
+
+      Gemlock::Config.parsed.should be_nil
+
+      Object.send(:remove_const, :Rails)
+    end
+
+    it "is nil if Rails is not defined and the file exists" do
+      Gemlock::Config.file.should be_nil
+    end
+  end
+
+  describe ".parsed" do
+    it "returns nil if the config file is not present" do
+      Gemlock::Config.stubs(:file).returns(nil)
+      Gemlock::Config.parsed.should be_nil
+    end
+
+    it "returns a hash containing the user's email if config file is present" do
+      Gemlock::Config.stubs(:file).returns((File.join(File.dirname(__FILE__), '..', 'fixtures', 'gemlock.yml')))
+      Gemlock::Config.parsed["email"].should eql "tester@example.com"
+    end
+  end
+
+  describe ".email" do
+    it "returns the email in the config if present and valid" do
+      Gemlock::Config.stubs(:parsed).returns({'email' => 'hi@mikeskalnik.com'})
+      Gemlock::Config.email.should eql 'hi@mikeskalnik.com'
+    end
+
+    it "returns nil if the email in the config is invalid" do
+      Gemlock::Config.stubs(:parsed).returns({'email' => 'd@er@p.com'})
+      Gemlock::Config.email.should be_nil
+    end
+
+    it "returns nil if there is no config" do
+      Gemlock::Config.stubs(:parsed).returns(nil)
+      Gemlock::Config.email.should be_nil
+    end
+  end
+
+  describe ".update_interval" do
+    it "returns the number of seconds in a week if config_file is not present, or interval is not specified" do
+      Gemlock::Config.update_interval.should eql 60*60*24*7
+
+      Gemlock::Config.stubs(:parsed).returns({"email"=>"tester@example.com"})
+      Gemlock::Config.update_interval.should eql 60*60*24*7
+    end
+
+    it "returns the number of seconds until the next number of hours as given" do
+      Gemlock::Config.stubs(:parsed).returns({"interval" => ["8 hours"]})
+      Gemlock::Config.update_interval.should eql 60*60*8
+    end
+
+    it "returns the number of seconds until the next number of days as given" do
+      Gemlock::Config.stubs(:parsed).returns({"interval" => ["4 days"]})
+      Gemlock::Config.update_interval.should eql 60*60*24*4
+    end
+
+    it "returns the number of seconds until the next number of weeks as given" do
+      Gemlock::Config.stubs(:parsed).returns({"interval" => ["2 weeks"]})
+      Gemlock::Config.update_interval.should eql 60*60*24*7*2
+    end
+
+    it "returns the number of seconds unil the next number of months as given" do
+      Gemlock::Config.stubs(:parsed).returns({"interval" => ["3 months"]})
+      Gemlock::Config.update_interval.should eql 60*60*24*30*3
+    end
+  end
+end

data/spec/gemlock_spec.rb

@@ -52,7 +52,7 @@ describe Gemlock do
     use_vcr_cassette
 
     it "returns a hash of outdated gems & versions specificed in config" do
-      Gemlock.stubs(:config).returns((File.join(File.dirname(__FILE__), 'fixtures', 'gemlock.yml')))
+      Gemlock::Config.stubs(:file).returns((File.join(File.dirname(__FILE__), 'fixtures', 'gemlock.yml')))
 
       gems = Gemlock.locked_gemfile_specs.inject({}) do |hash, spec|
         hash[spec.name] = spec.version.to_s
@@ -121,7 +121,7 @@ describe Gemlock do
     end
 
     it "sends the email address in config to the server if present" do
-      Gemlock.stubs(:parsed_config).returns({'email' => 'hi@mikeskalnik.com'})
+      Gemlock::Config.stubs(:parsed).returns({'email' => 'hi@mikeskalnik.com'})
       RestClient.expects(:get).with("http://gemlock.herokuapp.com/ruby_gems/updates.json",
                                     {:params => {:gems  => in_spec.to_json,
                                                  :email => 'hi@mikeskalnik.com'}}).returns('{}')
@@ -130,68 +130,6 @@ describe Gemlock do
     end
   end
 
-  describe ".config" do
-    it "loads gemlock.yml from the config directory if Rails is defined" do
-      module Rails
-        def self.root
-          Pathname.new(File.dirname(__FILE__))
-        end
-      end
-      expected_path = Pathname.new(File.dirname(__FILE__)).join('config', 'gemlock.yml')
-      File.stubs(:exists?).with(expected_path).returns(true)
-
-      Gemlock.config.should eql expected_path
-
-      # Undefine Rails module
-      Object.send(:remove_const, :Rails)
-
-    end
-
-    it "is nil if Rails is defined and the files does not exist" do
-      module Rails
-        def self.root
-          Pathname.new(File.dirname(__FILE__))
-        end
-      end
-
-      Gemlock.parsed_config.should be_nil
-
-      Object.send(:remove_const, :Rails)
-    end
-
-    it "is nil if Rails is not defined and the file exists" do
-      Gemlock.config.should be_nil
-    end
-  end
-
-  describe ".parsed_config" do
-    it "returns nil if the config file is not present" do
-      Gemlock.parsed_config.should be_nil
-    end
-
-    it "returns a hash containing the user's email if config file is present" do
-      Gemlock.stubs(:config).returns((File.join(File.dirname(__FILE__), 'fixtures', 'gemlock.yml')))
-
-      Gemlock.parsed_config["email"].should eql "tester@example.com"
-    end
-  end
-
-  describe ".email" do
-    it "returns the email in the config if present and valid" do
-      Gemlock.stubs(:parsed_config).returns({'email' => 'hi@mikeskalnik.com'})
-      Gemlock.email.should eql 'hi@mikeskalnik.com'
-    end
-
-    it "returns nil if the email in the config is invalid" do
-      Gemlock.stubs(:parsed_config).returns({'email' => 'd@er@p.com'})
-      Gemlock.email.should be_nil
-    end
-
-    it "returns nil if there is no config" do
-      Gemlock.stubs(:parsed_config).returns(nil)
-      Gemlock.email.should be_nil
-    end
-  end
 
   describe ".difference" do
     it "returns 'major' if there is a major version difference between the two gem versions" do
@@ -257,35 +195,6 @@ describe Gemlock do
     end
   end
 
-  describe ".update_interval" do
-    it "returns the number of seconds in a week if config_file is not present, or interval is not specified" do
-      Gemlock.update_interval.should eql 60*60*24*7
-
-      Gemlock.stubs(:parsed_config).returns({"email"=>"tester@example.com"})
-      Gemlock.update_interval.should eql 60*60*24*7
-    end
-
-    it "returns the number of seconds until the next number of hours as given" do
-      Gemlock.stubs(:parsed_config).returns({"interval" => ["8 hours"]})
-      Gemlock.update_interval.should eql 60*60*8
-    end
-
-    it "returns the number of seconds until the next number of days as given" do
-      Gemlock.stubs(:parsed_config).returns({"interval" => ["4 days"]})
-      Gemlock.update_interval.should eql 60*60*24*4
-    end
-
-    it "returns the number of seconds until the next number of weeks as given" do
-      Gemlock.stubs(:parsed_config).returns({"interval" => ["2 weeks"]})
-      Gemlock.update_interval.should eql 60*60*24*7*2
-    end
-
-    it "returns the number of seconds unil the next number of months as given" do
-      Gemlock.stubs(:parsed_config).returns({"interval" => ["3 months"]})
-      Gemlock.update_interval.should eql 60*60*24*30*3
-    end
-  end
-
   def capture_stdout
     io = StringIO.new
     $stdout = io

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: gemlock
 version: !ruby/object:Gem::Version
-  version: 0.2.2
+  version: 0.2.3
   prerelease: 
 platform: ruby
 authors:
@@ -12,11 +12,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2011-11-09 00:00:00.000000000Z
+date: 2011-12-04 00:00:00.000000000Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
-  requirement: &70123701965360 !ruby/object:Gem::Requirement
+  requirement: &70108593442260 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -24,10 +24,10 @@ dependencies:
         version: 0.8.7
   type: :runtime
   prerelease: false
-  version_requirements: *70123701965360
+  version_requirements: *70108593442260
 - !ruby/object:Gem::Dependency
   name: bundler
-  requirement: &70123701964760 !ruby/object:Gem::Requirement
+  requirement: &70108593441760 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -35,10 +35,10 @@ dependencies:
         version: 1.0.0
   type: :runtime
   prerelease: false
-  version_requirements: *70123701964760
+  version_requirements: *70108593441760
 - !ruby/object:Gem::Dependency
   name: rest-client
-  requirement: &70123701964260 !ruby/object:Gem::Requirement
+  requirement: &70108593441300 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -46,10 +46,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *70123701964260
+  version_requirements: *70108593441300
 - !ruby/object:Gem::Dependency
   name: json
-  requirement: &70123701963700 !ruby/object:Gem::Requirement
+  requirement: &70108593440580 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -57,10 +57,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *70123701963700
+  version_requirements: *70108593440580
 - !ruby/object:Gem::Dependency
   name: rspec
-  requirement: &70123701963080 !ruby/object:Gem::Requirement
+  requirement: &70108593439780 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -68,10 +68,10 @@ dependencies:
         version: 2.7.0
   type: :development
   prerelease: false
-  version_requirements: *70123701963080
+  version_requirements: *70108593439780
 - !ruby/object:Gem::Dependency
   name: mocha
-  requirement: &70123701956040 !ruby/object:Gem::Requirement
+  requirement: &70108593439040 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -79,10 +79,10 @@ dependencies:
         version: 0.10.0
   type: :development
   prerelease: false
-  version_requirements: *70123701956040
+  version_requirements: *70108593439040
 - !ruby/object:Gem::Dependency
   name: pry
-  requirement: &70123701955440 !ruby/object:Gem::Requirement
+  requirement: &70108593438540 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -90,10 +90,10 @@ dependencies:
         version: 0.9.5
   type: :development
   prerelease: false
-  version_requirements: *70123701955440
+  version_requirements: *70108593438540
 - !ruby/object:Gem::Dependency
   name: vcr
-  requirement: &70123701954840 !ruby/object:Gem::Requirement
+  requirement: &70108593437900 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -101,10 +101,10 @@ dependencies:
         version: 1.11.0
   type: :development
   prerelease: false
-  version_requirements: *70123701954840
+  version_requirements: *70108593437900
 - !ruby/object:Gem::Dependency
   name: fakeweb
-  requirement: &70123701954320 !ruby/object:Gem::Requirement
+  requirement: &70108593437260 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -112,7 +112,7 @@ dependencies:
         version: 1.3.0
   type: :development
   prerelease: false
-  version_requirements: *70123701954320
+  version_requirements: *70108593437260
 description: When installed, allows a user to check for updates in their Rails application
 email:
 - mskalnik@gatech.edu
@@ -130,8 +130,11 @@ files:
 - Rakefile
 - gemlock.gemspec
 - lib/gemlock.rb
+- lib/gemlock/config.rb
 - lib/gemlock/railtie.rb
 - lib/gemlock/version.rb
+- lib/generators/gemlock/config_generator.rb
+- lib/generators/templates/config.yml.erb
 - lib/rake_tasks.rb
 - lib/tasks/gemlock.rake
 - spec/fixtures/Gemfile
@@ -140,6 +143,7 @@ files:
 - spec/fixtures/vcr_cassettes/Gemlock/_check_gems_individually.yml
 - spec/fixtures/vcr_cassettes/Gemlock/_lookup_version.yml
 - spec/fixtures/vcr_cassettes/Gemlock/_outdated.yml
+- spec/gemlock/config_spec.rb
 - spec/gemlock_spec.rb
 - spec/spec_helper.rb
 homepage: ''
@@ -173,5 +177,6 @@ test_files:
 - spec/fixtures/vcr_cassettes/Gemlock/_check_gems_individually.yml
 - spec/fixtures/vcr_cassettes/Gemlock/_lookup_version.yml
 - spec/fixtures/vcr_cassettes/Gemlock/_outdated.yml
+- spec/gemlock/config_spec.rb
 - spec/gemlock_spec.rb
 - spec/spec_helper.rb