regulate 0.0.1 → 0.1.0

data/lib/regulate.rb

@@ -1,5 +1,7 @@
 # Requires
 require 'active_support/dependencies'
+require 'abstract_auth'
+require 'grit'
 
 # Our top level module to contain all of our engine gem functionality
 module Regulate
@@ -7,6 +9,11 @@ module Regulate
   # Autoloads
   autoload :Git , 'regulate/git'
 
+  # Setup our AbstractAuth requirements
+  AbstractAuth.setup do |config|
+    config.requires :authorized_user , :is_admin , :is_editor
+  end
+
   # Our host application root path
   # We set this when the engine is initialized
   mattr_accessor :app_root

data/lib/regulate/engine.rb

@@ -33,8 +33,8 @@ module Regulate
           init = true
         end
 
-        Grit::Repo.init(repo_path) if init
-        config.repo = Grit::Repo.new(repo_path)
+        ::Grit::Repo.init(repo_path) if init
+        config.repo = ::Grit::Repo.new(repo_path)
 
       end
 

data/lib/regulate/git.rb

@@ -1,6 +1,3 @@
-# Requires
-require 'grit'
-
 module Regulate
 
   # Our module to contain all get related functionality

data/lib/regulate/git/interface.rb

@@ -208,7 +208,7 @@ module Regulate
           {
             :name     => author_name.nil? ? "Anonymous" : author_name,
             :email    => author_email    ||= "anon@anonymous.com",
-            :message  => commit_message  ||= mode.eql?(:create) ? "Creating new page." : "Updating page."
+            :message  => commit_message  ||= mode.eql?(:create) ? "Committing resource changes." : "Deleting resource."
           }
         end
 

data/lib/regulate/git/model/base.rb

@@ -15,6 +15,8 @@ module Regulate
 
         # The three fields that we absolutely need to successfully save and render any cms based model
         validates_presence_of :id, :title, :view
+        validates_length_of :id , :minimum => 1 , :allow_nil => false , :allow_blank => false
+        validates_length_of :title , :minimum => 1 , :allow_nil => false , :allow_blank => false
 
         # Standard class init
         #
@@ -31,7 +33,7 @@ module Regulate
           clear_cached_vars
           Regulate::Git::Interface.delete({
             :id => id,
-            :commit_message => commit_message,
+            :commit_message => commit_message || "Deleting resource #{title}",
             :author_name => author_name,
             :author_email => author_email
           })
@@ -42,9 +44,10 @@ module Regulate
           return @_versions ||= Regulate::Git::Interface.commits(id)
         end
 
-        # Return the rendered.html file from the repo
+        # Return the rendered.html file from the repo or build the rendered html
         def rendered
-          return @_rendered ||= Regulate::Git::Interface.find_rendered(id)
+          @_rendered ||= ( persisted? ) ? Regulate::Git::Interface.find_rendered(id) : build_rendered_html
+          @_rendered
         end
 
         # Allow attributes to be mass assigned then saved
@@ -67,26 +70,28 @@ module Regulate
         # Attempt to save our record
         # @return [TrueClass,FalseClass] Whether or not the record was saved
         def save
-          if !persisted?
-            # Object create
-            # A git object with that id already exists
-            return false if self.class.exists?(id)
-          else
-            # Object update
-            # No git ID with the current id exists
-            # You are not allowed to change the ID of an object
-            return false if !self.class.exists?(id)
-          end
           if valid?
+            if !persisted?
+              # Object create
+              # A git object with that id already exists
+              return false if self.class.exists?(id)
+            else
+              # Object update
+              # No git ID with the current id exists
+              # You are not allowed to change the ID of an object
+              return false if !self.class.exists?(id)
+            end
+
             clear_cached_vars
             Regulate::Git::Interface.save({
               :id => id,
-              :commit_message => commit_message,
+              :commit_message => commit_message || "#{ ( persisted? ) ? "Updating" : "Creating" } resource #{title}",
               :author_name => author_name,
               :author_email => author_email,
               :attributes => attributes.to_json(:except => ['author_email', 'author_name', 'commit_message']),
               :rendered => build_rendered_html
             })
+            @persisted = true
           else
             false
           end
@@ -98,17 +103,22 @@ module Regulate
         # @raise [Regulate::Git::Errors::PageDoesNotExist] Throw this only if we are attempting to save an existing record and item does not already exist in the repo with the given ID
         # @raise [Regulate::Git::Errors::InvalidGitResourceError] Record is invalid and cannot save
         def save!
-          if !persisted?
-            # Object create
-            # A git object with that id already exists
-            raise Regulate::Git::Errors::DuplicatePageError if self.class.exists?(id)
+          if valid?
+            if !persisted?
+              # Object create
+              # A git object with that id already exists
+              raise Regulate::Git::Errors::DuplicatePageError if self.class.exists?(id)
+            else
+              # Object update
+              # No git ID with the current id exists
+              # You are not allowed to change the ID of an object
+              raise Regulate::Git::Errors::PageDoesNotExist if !self.class.exists?(id)
+            end
+
+            save
           else
-            # Object update
-            # No git ID with the current id exists
-            # You are not allowed to change the ID of an object
-            raise Regulate::Git::Errors::PageDoesNotExist if !self.class.exists?(id)
+            raise Regulate::Git::Errors::InvalidGitResourceError
           end
-          ( valid? ) ? save : raise(Regulate::Git::Errors::InvalidGitResourceError)
         end
 
         # Replaces mustache style syntax with appropriate instance attribute values
@@ -187,20 +197,36 @@ module Regulate
 
           # Search for by id, and return, a valid resource from the repo
           #
-          # @todo Should we be raising an exception here?
           # @raise [Regulate::Git::Errors::PageDoesNotExist] Raise this if the find fails
           # @return An instance of whatever class extends this base class
           def find(id)
+            resource_data = Regulate::Git::Interface.find(id)
+            self.new_from_git( resource_data )
+          end
+
+          # Search for by id, and return, a valid resource from the repo
+          #
+          # @raise [Regulate::Git::Errors::PageDoesNotExist] Raise this if the find fails
+          # @return An instance of whatever class extends this base class
+          def find!(id)
             resource_data = Regulate::Git::Interface.find(id) || raise(Regulate::Git::Errors::PageDoesNotExist)
             self.new_from_git( resource_data )
           end
 
           # Search for by version, and return, a valid resource from the repo
           #
-          # @todo Should we be raising an exception here?
           # @raise [Regulate::Git::Errors::PageDoesNotExist] Raise this if the find fails
           # @return an instance of whatever class extends this base class
           def find_by_version(id,commit_sha)
+            resource_data = Regulate::Git::Interface.find_by_version(id,commit_sha)
+            self.new_from_git( resource_data )
+          end
+
+          # Search for by version, and return, a valid resource from the repo
+          #
+          # @raise [Regulate::Git::Errors::PageDoesNotExist] Raise this if the find fails
+          # @return an instance of whatever class extends this base class
+          def find_by_version!(id,commit_sha)
             resource_data = Regulate::Git::Interface.find_by_version(id,commit_sha) || raise(Regulate::Git::Errors::PageDoesNotExist)
             self.new_from_git( resource_data )
           end
@@ -216,15 +242,13 @@ module Regulate
           def create( attributes = {} )
             temp = self.new(attributes)
             temp.save
-            temp_data = Regulate::Git::Interface.find(temp.id)
-            return self.new_from_git(temp_data)
+            return self.find(temp.id)
           end
 
           def create!( attributes = {} )
             temp = self.new(attributes)
             temp.save!
-            temp_data = Regulate::Git::Interface.find(temp.id)
-            return self.new_from_git(temp_data)
+            return self.find!(temp.id)
           end
 
         end
@@ -269,6 +293,7 @@ module Regulate
 
         # Accepts a JSON string and creates a new instance of the object
         def self.new_from_git( resource_data )
+          return nil if resource_data.nil?
           self.new( JSON.parse( resource_data ) , true )
         end
 

data/lib/regulate/version.rb

@@ -1,4 +1,4 @@
 module Regulate
   # Our gem version
-  VERSION = "0.0.1"
+  VERSION = "0.1.0"
 end

data/public/javascripts/regulate_admin.js

@@ -89,7 +89,7 @@
 
             label = $("<label>", {
               'for': 'page[edit_regions][' + new_key + ']',
-              'text': new_key.replace('_', " "),
+              'text': new_key.replace(/_/g, " "),
               'class': new_key
             });
 

data/public/javascripts/regulate_index.js

@@ -0,0 +1,32 @@
+// Triggers an event on an element and returns the event result
+function fire(obj, name, data) {
+  var event = new $.Event(name);
+  obj.trigger(event, data);
+  return event.result !== false;
+}
+function allowAction(element) {
+  var message = element.attr('data-confirm');
+  return !message || (fire(element, 'confirm') && confirm(message));
+}
+// Handles "data-method" on links such as:
+// <a href="/users/5" data-method="delete" rel="nofollow" data-confirm="Are you sure?">Delete</a>
+function handleMethod(link) {
+  var href = link.attr('href'),
+    method = link.attr('data-method'),
+    csrf_token = $('meta[name=csrf-token]').attr('content'),
+    csrf_param = $('meta[name=csrf-param]').attr('content'),
+    form = $('<form method="post" action="' + href + '"></form>'),
+    metadata_input = '<input name="_method" value="' + method + '" type="hidden" />';
+  if (csrf_param !== undefined && csrf_token !== undefined) {
+    metadata_input += '<input name="' + csrf_param + '" value="' + csrf_token + '" type="hidden" />';
+  }
+  form.hide().append(metadata_input).appendTo('body');
+  form.submit();
+}
+$('a.delete_link').bind('click',function(e){
+  var link = $(this);
+  if (!allowAction(link)){ return false; }
+  handleMethod(link);
+  return false;
+});
+

data/regulate.gemspec

@@ -16,6 +16,7 @@ Gem::Specification.new do |s|
 
   s.add_dependency "rails", "~> 3.0.0"
   s.add_dependency "grit", "~> 2.3.0"
+  s.add_dependency "abstract_auth", "~> 0.1.0"
   s.add_development_dependency "bluecloth", "~> 2.0.9"
   s.add_development_dependency "bundler", "~> 1.0.0"
   s.add_development_dependency "capybara", "~> 0.4.0"

data/test/dummy/app/controllers/application_controller.rb

@@ -1,3 +1,9 @@
 class ApplicationController < ActionController::Base
+
   protect_from_forgery
+
+  def self.current_user
+    User.new
+  end
+
 end

data/test/dummy/app/models/user.rb

@@ -0,0 +1,20 @@
+class User
+
+  attr_accessor :role , :first_name , :last_name , :email
+
+  def initialize
+    @role = "editor"
+    @first_name = "Sir Lucius"
+    @last_name = "Leftfoot"
+    @email = "sir_lucius@quickleft.com"
+  end
+
+  def is_admin?
+    @role == "admin"
+  end
+
+  def is_editor?
+    @role == "editor"
+  end
+
+end

data/test/dummy/config/initializers/regulate.rb

@@ -0,0 +1,14 @@
+# Regulate stuff
+
+# AbstractAuth Implementations
+AbstractAuth.implement :authorized_user do
+  ::ApplicationController.instance_eval "current_user"
+end
+
+AbstractAuth.implement :is_admin do
+  ::ApplicationController.instance_eval("current_user").is_admin?
+end
+
+AbstractAuth.implement :is_editor do
+  ::ApplicationController.instance_eval("current_user").is_editor?
+end

data/test/generators/mount_up_generator_test.rb

@@ -0,0 +1,15 @@
+require 'test_helper'
+require "rails/generators/test_case"
+require File.join(File.dirname(__FILE__), "../../lib/generators/regulate/mount_up_generator")
+
+class MountUpGeneratorTest < Rails::Generators::TestCase
+  tests Regulate::Generators::MountUpGenerator
+  destination File.expand_path("../tmp", File.dirname(__FILE__))
+  setup :prepare_destination
+
+  test "Assert all files are properly created" do
+    run_generator
+    assert_file "config/initializers/regulate.rb"
+  end
+end
+

data/test/generators/strap_generator_test.rb

@@ -0,0 +1,22 @@
+require 'test_helper'
+require "rails/generators/test_case"
+require File.join(File.dirname(__FILE__), "../../lib/generators/regulate/strap_generator")
+
+class StrapGeneratorTest < Rails::Generators::TestCase
+  tests Regulate::Generators::StrapGenerator
+  destination File.expand_path("../tmp", File.dirname(__FILE__))
+  setup :prepare_destination
+
+  test "Assert all files are properly created" do
+    run_generator
+    assert_file "app/views/regulate/admin/pages/index.html.erb" 
+    assert_file "app/views/regulate/admin/pages/_form.html.erb"
+    assert_file "app/views/regulate/admin/pages/edit.html.erb"
+    assert_file "app/views/regulate/admin/pages/new.html.erb"
+    assert_file "app/views/regulate/pages/show.html.erb"
+    assert_file "public/javascripts/regulate_admin.js"
+    assert_file "config/regulate.yml"
+  end
+end
+
+

data/test/models/regulate_git_model_base_test.rb

@@ -2,22 +2,191 @@ require 'test_helper'
 
 class Regulate::Git::Model::BaseTest < ActiveSupport::TestCase
 
+  @@iterator = 0
+
+  def get_iterator
+    @@iterator += 1
+    @@iterator
+  end
+
   def setup
+    iterator = get_iterator
     @resource = Regulate::Git::Model::Base.new({
-      :title => "Happy Title",
-      :view => "{{title}}"
+      :id => "happy-title-#{iterator}",
+      :title => "Happy Title #{iterator}",
+      :view => "<h1>{{title}}</h1>"
     })
   end
 
+  # /////////
+  # Instance Methods
+  # /////////
+
   test "new is not persisted" do
-    assert_equal false , @resource.persisted?
+    assert !@resource.persisted?
+  end
+
+  test "resource without id is not valid" do
+    @resource.id = nil
+    assert !@resource.valid?
+  end
+
+  test "resource save when invalid returns false" do
+    @resource.id = nil
+    assert !@resource.save
+  end
+
+  test "resource save! when inavlid throws error" do
+    @resource.id = nil
+    assert_raise Regulate::Git::Errors::InvalidGitResourceError do
+      @resource.save!
+    end
+  end
+
+  test "can save a resource" do
+    assert @resource.save
+  end
+
+  test "resource is persisted after save" do
+    @resource.save
+    assert @resource.persisted?
   end
 
-  test "new sets attr methods" do
-    assert_respond_to @resource , :title
-    assert_respond_to @resource , :title=
-    assert_respond_to @resource , :title?
+  test "can delete a resource" do
+    @resource.save
+    assert @resource.destroy
+    assert_nil Regulate::Git::Model::Base.find(@resource.id)
   end
 
+  test "can update attributes of saved resource" do
+    @resource.save
+    assert @resource.update_attributes({
+      :title => "Whoa New Title"
+    })
+    updated_resource = Regulate::Git::Model::Base.find(@resource.id)
+    assert_not_nil updated_resource
+    assert_equal "Whoa New Title" , updated_resource.title
+  end
+
+  test "cannot change id when saving resource" do
+    @resource.save
+    assert !@resource.update_attributes({
+      :id => "whoa-new-title",
+      :title => "Whoa New Title"
+    })
+    assert_nil Regulate::Git::Model::Base.find("whoa-new-title")
+  end
+
+  test "can get a list of versions of a resource" do
+    @resource.save
+    versions = @resource.versions
+    assert_equal 1 , versions.length
+    assert_kind_of Grit::Commit , versions[0]
+  end
+
+  test "can build the rendered html" do
+    assert_equal "<h1>Happy Title #{@@iterator}</h1>" , @resource.build_rendered_html
+    assert_equal "<h1>Happy Title #{@@iterator}</h1>" , @resource.rendered
+  end
+
+  test "can grab the rendered html from git" do
+    @resource.save
+    assert_equal "<h1>Happy Title #{@@iterator}</h1>" , @resource.rendered
+  end
+
+  test "can get our attributes as a hash" do
+    assert_kind_of Hash , @resource.attributes
+    assert_equal "happy-title-#{@@iterator}" , @resource.attributes["id"]
+    assert_equal "Happy Title #{@@iterator}" , @resource.attributes["title"]
+    assert_equal "<h1>{{title}}</h1>" , @resource.attributes["view"]
+  end
+
+  # /////////
+  # End Instance Methods
+  # /////////
+
+  # /////////
+  # Class Methods
+  # /////////
+
+  test "can setup class level attributes" do
+    class ::RandomTestClass < Regulate::Git::Model::Base
+      attributes :a_random_attribute
+    end
+    assert RandomTestClass._attributes.include?(:a_random_attribute)
+    x = RandomTestClass.new
+    assert_respond_to x , :a_random_attribute
+    assert_respond_to x , :a_random_attribute=
+    assert_respond_to x , :a_random_attribute?
+  end
+
+  test "can check if a resource with the given id exists" do
+    @resource.save
+    assert Regulate::Git::Model::Base.exists?(@resource.id)
+  end
+
+  test "can find a git resource given an id" do
+    @resource.save
+    found = Regulate::Git::Model::Base.find(@resource.id)
+    assert_not_nil found
+    assert_kind_of Regulate::Git::Model::Base , found
+  end
+
+  test "find will return nil if nothing is found" do
+    assert_nil Regulate::Git::Model::Base.find("a-random-id")
+  end
+
+  test "find! will raise an exception if nothing is found" do
+    assert_raise Regulate::Git::Errors::PageDoesNotExist do
+      Regulate::Git::Model::Base.find!("a-random-id")
+    end
+  end
+
+  test "can find a version of a git resource by id and sha" do
+    @resource.save
+    @resource.title = "Oh Hey a new TItle!"
+    @resource.save
+    versions = @resource.versions
+    assert_equal 2 , versions.length
+    old_version = Regulate::Git::Model::Base.find_by_version(@resource.id,versions[1].sha)
+    assert_not_nil old_version
+    assert_equal "Happy Title #{@@iterator}" , old_version.title
+  end
+
+  test "find_by_versions! will raise an exception if nothing is found" do
+    assert_raise Regulate::Git::Errors::PageDoesNotExist do
+      Regulate::Git::Model::Base.find_by_version!("a-random-id","2798hjfsdjfgk25jklj")
+    end
+  end
+
+  test "find_all returns all resources in the repo" do
+    all = Regulate::Git::Model::Base.find_all
+    assert_operator 1 , :< , all.length
+    assert_kind_of Regulate::Git::Model::Base , all[0]
+  end
+
+  test "can create with attributes hash" do
+    new_resource = Regulate::Git::Model::Base.create({
+      :id => "happy-title-#{@@iterator}",
+      :title => "Happy Title #{@@iterator}",
+      :view => "<h1>{{title}}</h1>"
+    })
+    assert_not_nil new_resource
+    assert_kind_of Regulate::Git::Model::Base , new_resource
+    assert new_resource.persisted?
+  end
+
+  test "create will return nil" do
+    new_resource = Regulate::Git::Model::Base.create({
+      :title => "Happy Title #{@@iterator}",
+      :view => "<h1>{{title}}</h1>"
+    })
+    assert_nil new_resource
+  end
+
+  # /////////
+  # End Class Methods
+  # /////////
+
 end