fragmentary 0.1.0

data/lib/fragmentary/user_session.rb

@@ -0,0 +1,53 @@
+require 'rails/console/app'
+
+module Fragmentary
+
+  class UserSession
+
+    include Rails::ConsoleMethods
+
+    attr_reader :session, :user
+
+    def initialize(*user, &block)
+      # app is from Rails::ConsoleMethods. It returns an object ActionDispatch::Integration::Session.new(Rails.application)
+      # with some extensions. See https://github.com/rails/rails/blob/master/railties/lib/rails/console/app.rb
+      # The session object has instance methods get, post etc.
+      # See https://github.com/rails/rails/blob/master/actionpack/lib/action_dispatch/testing/integration.rb
+      @session = app
+      sign_in if @user = get_user(*user)
+      instance_eval(&block) if block_given?
+    end
+
+    def method_missing(method, *args)
+      session.send(method, *args)
+    end
+
+    def sign_out
+      post '/users/sign_out', {:_method => 'delete', :authenticity_token => request.session[:_csrf_token]}
+    end
+
+    def sign_in
+      get "/users/sign_in"  # necessary in order to get the csrf token
+      # NOTE: In Rails 5, params is changed to a named argument, i.e. :params => {...}. Will need to be changed.
+      post "/users/sign_in", {:user => {:email => user.email, :password => user.try(:password)},
+                              :authenticity_token => request.session[:_csrf_token]}
+      if session.redirect?
+        follow_redirect!
+      else
+        raise "Sign in failed for user #{user.name} #{user.password}"
+      end
+    end
+
+    private
+    def get_user(*attrs)
+      return nil if attrs.nil?
+      if (user = attrs.shift).is_a? User and user.password
+        user
+      elsif user.is_a? String
+        User.test_user(user, :admin => attrs.shift.try(:delete, :admin))
+      end
+    end
+
+  end
+
+end

data/lib/fragmentary/version.rb

@@ -0,0 +1,3 @@
+module Fragmentary
+  VERSION = "0.1.0"
+end

data/lib/fragmentary/widget.rb

@@ -0,0 +1,56 @@
+module Fragmentary
+
+  class Widget
+    attr_reader :template, :key, :match
+
+    def self.inherited subclass
+      super if defined? super
+      @subclasses ||= []
+      @subclasses << subclass
+    end
+
+    def self.subclasses
+      @subclasses ||= []
+      @subclasses.inject([]) do |list, subclass|
+        list.push(subclass, *subclass.subclasses)
+      end
+    end
+
+    def initialize(template, key)
+      @template = template
+      @key = key
+      @match = key.match(pattern)
+    end
+
+    def pattern
+      Regexp.new('^$')
+    end
+
+    def _content
+      match ? content : nil
+    end
+
+    def content
+      "Undefined Widget"
+    end
+  end
+
+
+  class UserWidget < Widget
+    attr_reader :current_user
+
+    def initialize(template, key)
+      super
+      @current_user = template.respond_to?(:current_user) ? template.current_user : nil
+    end
+
+    def _content
+      match ? user_content : nil
+    end
+
+    def user_content
+      current_user ? content : ""
+    end
+  end
+
+end

data/lib/fragmentary/widget_parser.rb

@@ -0,0 +1,46 @@
+module Fragmentary
+
+  class WidgetParser
+
+    include ActionView::Helpers::JavaScriptHelper
+
+    attr_reader :template, :current_user, :widget_container
+
+    def initialize(template)
+      @template = template
+      @widget_container = {:'' => 'Empty widget specification detected'}
+    end
+
+    # This method returns a new OutputBuffer instance that can be used to overwrite the existing
+    # template's output_buffer with a copy that has its widget specifications expanded. It is
+    # usually called from cache_fragment to insert widgets into a cached root fragment. However
+    # when an ajax request inserts a non-root fragment into a page it can be invoked from
+    # CacheBuilder#cache_child if that method is called with the :insert_widgets option set to
+    # true. Alternatively if an ajax request inserts content containing a widget without a fragment
+    # context, i.e. in order to modify content *within* a fragment, a WidgetParser can be
+    # instantiated separately using erb at the end of the view template. This can be done either
+    # in an html template if the client is loading html by ajax (e.g. jQuery.load) or in a js(.coffee)
+    # script if the ajax request loads javascript.
+    def parse_buffer(options = {})
+      template.output_buffer.scan(/%{([^}]+)}/) do |spec|
+        widget_key = spec[0]; widget = nil
+        widget_container[widget_key.to_sym] = if Widget.subclasses.find{|klass| (widget = klass.new(template, widget_key)).match}
+          if options[:javascript] or options[:js]
+            escape_javascript(widget._content)
+          else
+            widget._content
+          end
+        else
+          "Oops! Widget not found."
+        end
+      end
+      # The gsub replaces instances of '%' that aren't part of widget specifications with '%%', preventing
+      # those characters from making the buffer an invalid format specification. The substitution operation
+      # restores them to single characters. The new OutputBuffer is needed because gsub returns a string.
+      # (Although gsub! would return an OutputBuffer if a substitution occurs, it returns nil otherwise,
+      # so isn't suitable here.)
+      ActionView::OutputBuffer.new(template.output_buffer.gsub(/%(?!{)/,'%%') % widget_container)
+    end
+  end
+
+end

metadata

@@ -0,0 +1,158 @@
+--- !ruby/object:Gem::Specification
+name: fragmentary
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Mark Thomson
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2018-12-07 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 4.0.0
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '5'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 4.0.0
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '5'
+- !ruby/object:Gem::Dependency
+  name: delayed_job_active_record
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.1'
+- !ruby/object:Gem::Dependency
+  name: wisper-activerecord
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.17'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.17'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+description: Fragment caching for Rails with arbitrarily complex data dependencies
+email:
+- mark.thomson@persuasivethinking.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- fragmentary.gemspec
+- lib/fragmentary.rb
+- lib/fragmentary/dispatcher.rb
+- lib/fragmentary/fragment.rb
+- lib/fragmentary/fragments_helper.rb
+- lib/fragmentary/handler.rb
+- lib/fragmentary/publisher.rb
+- lib/fragmentary/request.rb
+- lib/fragmentary/request_queue.rb
+- lib/fragmentary/subscriber.rb
+- lib/fragmentary/subscription.rb
+- lib/fragmentary/user_session.rb
+- lib/fragmentary/version.rb
+- lib/fragmentary/widget.rb
+- lib/fragmentary/widget_parser.rb
+homepage: https://github.com/MarkMT/fragmentary
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.4.8
+signing_key: 
+specification_version: 4
+summary: Fragment modeling and caching for Rails
+test_files: []