nice 0.0.7 → 0.1.0

data/lib/nice/js/caller.rb

@@ -1,48 +0,0 @@
-module Nice
-	module Js
-		class Caller
-
-			# DOM Manipulation
-			def self.generate_js_insert_after new_node, reference_node_ref
-				"NiceEventDispatcher.dispatch_event(\'nice.dom.InsertAfterEvent\',{new_node:\'#{new_node}\', ref_node:\"#{reference_node_ref}\"});"
-			end
-
-			def self.generate_js_insert_inside new_node, reference_node_ref
-				"NiceEventDispatcher.dispatch_event(\'nice.dom.InsertInsideEvent\',{new_node:\'#{new_node}\', ref_node:\"#{reference_node_ref}\"});"			
-			end
-
-			def self.replace_node new_node, reference_node_ref
-				"NiceEventDispatcher.dispatch_event(\'nice.dom.ReplaceEvent\',{new_node:\'#{new_node}\', ref_node:\"#{reference_node_ref}\"});"			
-			end
-
-			def self.generate_js_remove curr_state
-				"NiceEventDispatcher.dispatch_event(\'nice.dom.RemoveStateEvent\',{curr_state:\'#{curr_state}\'});"				
-			end
-			
-			def self.clean_root_tree
-			  "NiceEventDispatcher.dispatch_event(\'nice.dom.CleanRootEvent\',{});"				
-			end			
-
-
-			# History Manipulation
-			def self.move_to_url url, title
-				"NiceEventDispatcher.dispatch_event(\'nice.hist.ChangeURLEvent\',{url:\'#{url}\', title:\'#{title}\'});"
-			end
-
-			def self.insert_or_update_back_listener url
-				"NiceEventDispatcher.dispatch_event(\'nice.hist.PopHistoryEvent\',{url:\'#{url}\'});"
-			end
-
-			# events for UI
-			def self.state_did_change prev_state, new_state
-				"NiceEventDispatcher.dispatch_event(\'nice.ui.StateDidChangeEvent\',{prev_state:\'#{prev_state}\', new_state:\"#{new_state}\"});"
-			end
-			
-			# Change Body Css Class to reflect current state
-			def self.change_top_css new_state_name
-			  "NiceEventDispatcher.dispatch_event(\'nice.dom.ChangeTopCssEvent\',{new_state_name:\'#{new_state_name}\'});"
-			end
-			
-		end
-	end
-end

data/lib/nice/logic.rb

@@ -1,99 +0,0 @@
-require 'nice/html_parser'
-require 'nice/js/caller'
-require 'uri'
-
-module Nice
-
-	# The nice state engine is tighthly integrated with restful routes. Each route can be a state
-	# and states are only identified by their corresponding route. In effect, no state names
-	# must be created and no parameters indicating the state transitions are needed as this
-	# information is already contained in the http header.
-
-    ## case 1: this is the first call of the component -> no previous state
-		
-		# => 	remove elements not belonging to the start state, generate UID for reference
-		#		nodes ({ref_element}_ref) and respond with HTML
-		
-	## case 2: this is an ordinary call of another state
-		
-		# => 	respond with JS with assignments to remove elements not included
-		#		in current state and assignments to insert elements of current state.
-		
-		
-	## case 3: curr_state == prev_state 
-		
-		# => 	respond with JS which either first removes all elements of the current state and
-		#		later inserts new content OR directly replaces elements
-		
-	## case 4: the controller changed
-	  # => replace all contents under the "container yield" mentioned in the application layout file
-	
-  class Logic
-    
-    def self.run current_method, current_path, referer, doc, is_js
-
-        ref_c = Rails.application.routes.recognize_path(referer)[:controller]
-        ref_a = Rails.application.routes.recognize_path(referer)[:action]
-    	  curr_c = Rails.application.routes.recognize_path(current_path)[:controller]
-    	  curr_a = Rails.application.routes.recognize_path(current_path)[:action]
-    	
-    	  current_state = "#{current_method.downcase}_#{curr_c}_#{curr_a}"
-    	
-    	  prev_state = referer.gsub("/","_") unless referer.nil?
-
-      	referenced_doc = Nice::HtmlParser.annotate_referencing_nodes doc	
-
-      	cleaned_doc = Nice::HtmlParser.remove_elements_not_of_state current_state, referenced_doc
-      	
-      	controller_same = (ref_c == curr_c)
-      	
-      	# case 1
-      	if !is_js then   
-
-          response = Nice::HtmlParser.add_top_css(cleaned_doc, current_state).to_html
-
-      	# case 2
-      	elsif controller_same && is_js then   
-      		js_stack = ["// remove elements not present in the following state"]
-      		js_stack << Nice::Js::Caller.generate_js_remove(current_state)
-
-      		js_stack << "// add new elements"
-      		js_stack += Nice::HtmlParser.add_elements_of_current_state(cleaned_doc,current_state).compact
-      		
-      	# case 4
-      	elsif !controller_same && is_js then
-      		js_stack = ["// remove elements not present in the following state"]
-      		js_stack << Nice::Js::Caller.generate_js_remove(current_state)
-      		      	  
-          js_stack << ["// remove elements below root"]
-      		js_stack << Nice::Js::Caller.clean_root_tree
-      		
-      		js_stack << "// add new content tree blow root tag"
-      		js_stack += Nice::HtmlParser.add_root_content(cleaned_doc).compact
-      		
-      		js_stack << "// add elements of the current state above root"
-      		js_stack += Nice::HtmlParser.add_elements_of_current_state(cleaned_doc,current_state,true).compact      		
-      	end
-      	
-      	# add completing js 
-      	if is_js then
-      	  js_stack << "// add browser history scripts"		
-      		js_stack << Nice::Js::Caller.move_to_url(current_path,"title")
-      		js_stack << Nice::Js::Caller.insert_or_update_back_listener(referer)
-
-      		js_stack << "// inform ui on state change"
-      		js_stack << Nice::Js::Caller.state_did_change(prev_state,current_state)
-
-          js_stack << "// switch body css class"      		
-      		js_stack << Nice::Js::Caller.change_top_css(current_state)
-      		
-      	  js_stack << "// AJAX RAILS ENGINE (nice.codebility.com)"		      		
-      		      		
-      		response = js_stack.join("\n")
-      	end
-      	
-      	response
-    end
-    
-  end
-end

data/lib/nice/middleware.rb

@@ -1,100 +0,0 @@
-require 'nokogiri'
-require 'nice/logic'
-
-module Nice
-  class Middleware
-    
-    ## case 1: this is the first call of the component -> no previous state
-		
-		# => 	remove elements not belonging to the start state, generate UID for reference
-		#		nodes ({ref_element}_ref) and respond with HTML
-		
-		## case 2: this is an ordinary call of another state
-		
-		# => 	respond with JS with assignments to remove elements not included
-		#		in current state and assignments to insert elements of current state.
-		
-		
-		## case 3: curr_state == prev_state 
-		
-		# => 	respond with JS which either first removes all elements of the current state and
-		#		later inserts new content OR directly replaces elements    
-		
-		
-		## case 4: this is a normal ajax request responding with javascript from rails
-		
-		# => ignore any NICE handling and return body unfiltered
-		
-    
-    def initialize(app)
-      @app = app
-    end
-  
-    def call(env)
-      @doc = nil
-      @referer = nil
-
-      status, @headers, @body = @app.call(env)
-                                                     
-      p ""
-      p "!!!!!!!! RAILS RESPONSE HEADERS: #{@headers}"
-      p ""
-      
-      @call_is_js = Rack::Request.new(env).xhr?
-      @app_resp_is_js = js?
-            
-      if !@app_resp_is_js && (html? || @call_is_js)
-        
-        @referer = env["HTTP_REFERER"]
-      	@method = env["REQUEST_METHOD"]
-      	@path = env["PATH_INFO"]
-
-      	# in case 2+3 the response will be plain javascript
-      	if @call_is_js
-      	  @headers = {"Content-Type" => "text/javascript"}
-      	end
-
-        [status, @headers, self]
-      
-      else
-        [status, @headers, @body]      
-      end
-    end
-    
-    def each(&block)         
-
-      if !@app_resp_is_js && (html? || @call_is_js)
-        block.call("<!-- NICE Interception -->\n")
-        block.call( Nice::Logic.run( @method, @path, @referer, doc, @call_is_js) )
-      else        
-        block.call(@body)      
-      end
-      
-    end
-    
-    # Helper
-    private 
-    
-    def html?
-      @headers["Content-Type"] && @headers["Content-Type"].include?("text/html")
-    end
-    
-    def js?
-      @headers["Content-Type"] && ( @headers["Content-Type"].include?("text/javascript") || @headers["Content-Type"].include?("application/json") )
-    end
-
-    def doc
-      @doc ||= Nokogiri::HTML(body_to_string)
-    end
-  
-    def body_to_string
-      s = ""
-      @body.each { |x| s << x }
-      s
-    end
-    
-    def update_content_length
-      @headers['Content-Length'] = Rack::Utils.bytesize(@body).to_s
-    end    
-  end
-end

data/lib/tasks/nice_tasks.rake

@@ -1,4 +0,0 @@
-# desc "Explaining what the task does"
-# task :nice do
-#   # Task goes here
-# end

data/test/integration/nice_test.rb

@@ -1,25 +0,0 @@
-require 'test_helper'
-
-class NiceTest < ActionDispatch::IntegrationTest
-  #fixtures :all
-
-  test "HTML response should not contain any non relevant state elements" do
-	# given we make an initial call
-	visit a_basic_index_path
-
-	# then the html response should not contain any elements only owned by other states
-	assert_have_no_selector "[data-state]:not([data-state~=get_basic_a])"
-  end  
-
-  test "state change should remove all not relevant elements" do
-  	# given we make an initial call
-  	visit a_basic_index_path
-
-  	# when switching the state from A -> B
-  	click_link "State B"
-
-  	# then the resulting page should not contain elements only owned by other states
-	assert_have_no_selector "[data-state]:not([data-state~=get_basic_b])"
-  end
-
-end

data/test/test_helper.rb

@@ -1,30 +0,0 @@
-# Configure Rails Environment
-ENV["RAILS_ENV"] = "test"
-
-require File.expand_path("../nizzaTestApp/config/environment",  __FILE__)
-require "rails/test_help"
-require "haml"
-
-Rails.backtrace_cleaner.remove_silencers!
-
-# Load support files
-Dir["#{File.dirname(__FILE__)}/support/**/*.rb"].each { |f| require f }
-
-# load test applications
-Dir[File.expand_path('../nizzaTestApp/*.rb', __FILE__)].each do |f|
-  require f
-end
-
-# Load fixtures from the engine
-if ActiveSupport::TestCase.method_defined?(:fixture_path=)
-  ActiveSupport::TestCase.fixture_path = File.expand_path("../fixtures", __FILE__)
-end
-
-require "webrat"
-
-Webrat.configure do |config|
-  config.mode = :rack
-#  config.application_framework = :rails
-#  config.selenium_server_address = "127.0.0.1"
-#  config.selenium_server_port = "3000"
-end