nesta-plugin-related-by-category 0.0.1

checksums.yaml

@@ -0,0 +1,15 @@
+---
+!binary "U0hBMQ==":
+  metadata.gz: !binary |-
+    NzJlZDBjZDY1Yzc4ZGI5MGEwMWFkOTRkZjc5ZDFhNjQ3ODkxOWM5MA==
+  data.tar.gz: !binary |-
+    ZjJjYmE0YTg1YmJjZmMzYTY1YWNlMDc5NDJjZmE4MTFlYmVmYzU1ZA==
+!binary "U0hBNTEy":
+  metadata.gz: !binary |-
+    ZWQ5MWNmZTY4ZTM2MGU2ODBkNTdiMzE0ZWYyYTJmMDI2MmEzZTYxNjIyMmUy
+    NTAzNjQ4MjQ2M2U1NzE5MTBlNDVmZWVkNWI0YmRhNGJjODFjZWVhMmRiZmQx
+    Njc4ZWIyODY5NWFiNjhhNWE4MWUyNmY2NDAwZDU4MzI0NWEwMjE=
+  data.tar.gz: !binary |-
+    M2ZjYWQ2NTYyNzI0NzAzYzIzNGUzODc5M2E1MGY2ZmZlYjk5ZmFjMmVlMjYw
+    NmUxZjMyMWEyYzc2NGNkMjk4NzQxOWUzZDk0YTEyZjg2N2M0YTY0NGZhZTFj
+    MDRjNTUyZjhmNWRjZDRkZDU3YjJjZjU3YThlYWQyZTk5MTFkMjQ=

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in nesta-plugin-related-by-category.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 James Abbott
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,47 @@
+# Nesta::Plugin::RelatedByCategory
+
+A plugin for finding related articles to a Nesta article, based on a dead-simple idea:
+
+**Given pages A and B, the more categories A and B have in common, the higher B's relevance to A.**
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'nesta-plugin-related-by-category'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install nesta-plugin-related-by-category
+
+## Usage
+
+In your Nesta `/views` folder, declare a `related_articles.haml` with something like the following:
+
+    - if has_related_articles?(@page)
+      %section.related-articles
+        %h2 Related articles
+        %ul
+          - related_by_category(@page).each do |article|
+            %li
+              %a(href="#{article.abspath}")= article.heading
+
+Then, at the bottom of your template file (`page.haml` is default), reference it:
+
+    = haml :related_articles, :layout => false
+
+By default, the plugin will display 3 articles; this can be overridden by a number of your choice:
+
+    related_by_category(@page, 5) # 2nd argument is the number of articles to display.
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/lib/nesta-plugin-related-by-category.rb

@@ -0,0 +1,3 @@
+require "nesta-plugin-related-by-category/version"
+
+Nesta::Plugin.register(__FILE__)

data/lib/nesta-plugin-related-by-category/init.rb

@@ -0,0 +1,57 @@
+module Nesta
+  module Plugin
+    module RelatedByCategory
+
+      module Helpers
+        def has_related_articles?(page)
+          !(Nesta::Plugin::RelatedByCategory.articles_through_categories(page).empty?)
+        end
+
+        def related_by_category(page, number=3)
+         Nesta::Plugin::RelatedByCategory.for_page(page, number)
+        end
+      end
+
+      def self.ranked_by_relevance(page)
+        results = {}
+        articles_through_categories(page).each do |article|
+          rank = relevance(page, article)
+          if results.has_key? rank
+            results[rank] << article
+          else
+            results.store(rank, [article])
+          end
+        end
+        results.sort.reverse.flatten.reject {|el| !el.class.eql? Page}
+      end
+
+      def self.articles_through_categories(page)
+        related = page.categories.map {|c| c.articles}.flatten
+        set = Set.new(related).to_a
+        set.delete page
+        set
+      end
+
+      def self.relevance(page, other)
+        (tags(page) & tags(other)).count
+      end
+
+      def self.tags(page)
+        page.categories.map {|c| c.heading}
+      end
+
+      def self.display(results, number)
+        results.take(number)
+      end
+
+      def self.for_page(page, number)
+        display(ranked_by_relevance(page), number)
+      end
+    end
+  end
+
+  class App
+    helpers Nesta::Plugin::RelatedByCategory::Helpers
+  end
+end
+

data/lib/nesta-plugin-related-by-category/version.rb

@@ -0,0 +1,7 @@
+module Nesta
+  module Plugin
+    module RelatedByCategory
+      VERSION = "0.0.1"
+    end
+  end
+end

data/nesta-plugin-related-by-category.gemspec

@@ -0,0 +1,21 @@
+# -*- encoding: utf-8 -*-
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'nesta-plugin-related-by-category/version'
+
+Gem::Specification.new do |gem|
+  gem.name          = "nesta-plugin-related-by-category"
+  gem.version       = Nesta::Plugin::RelatedByCategory::VERSION
+  gem.authors       = ["James Abbott"]
+  gem.email         = ["abbottjam@gmail.com"]
+  gem.description   = %q{A plugin that finds related articles to a Nesta article, based on the relationship between its categories and other articles.}
+  gem.summary       = %q{A plugin that finds related articles to a Nesta article, based on the relationship between its categories and other articles.}
+  gem.homepage      = "https://github.com/abbottjam/nesta-plugin-related-by-category"
+
+  gem.files         = `git ls-files`.split($/)
+  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.require_paths = ["lib"]
+  gem.add_dependency("nesta", ">= 0.9.11")
+  gem.add_development_dependency("rake")
+end

data/spec/fixtures/content/pages/bach.mdown

@@ -0,0 +1,6 @@
+date: 29 December 2008
+categories: classical
+
+#  Johann Sebastian Bach
+
+Content goes here

data/spec/fixtures/content/pages/blues.mdown

@@ -0,0 +1,5 @@
+
+
+#  Blues
+
+Content goes here

data/spec/fixtures/content/pages/classical.mdown

@@ -0,0 +1,5 @@
+
+
+#  Classical
+
+Content goes here

data/spec/fixtures/content/pages/cream.mdown

@@ -0,0 +1,6 @@
+date: 29 December 2008
+categories: rock, blues, jazz, heavy
+
+#  Cream
+
+Content goes here

data/spec/fixtures/content/pages/folk.mdown

@@ -0,0 +1,5 @@
+
+
+#  Folk
+
+Content goes here

data/spec/fixtures/content/pages/funk.mdown

@@ -0,0 +1,5 @@
+
+
+#  Funk
+
+Content goes here

data/spec/fixtures/content/pages/heavy.mdown

@@ -0,0 +1,5 @@
+
+
+#  Heavy
+
+Content goes here

data/spec/fixtures/content/pages/hendrix.mdown

@@ -0,0 +1,6 @@
+date: 29 December 2008
+categories: rock, blues, jazz, heavy
+
+#  Jimi Hendrix
+
+Content goes here

data/spec/fixtures/content/pages/jazz.mdown

@@ -0,0 +1,5 @@
+
+
+#  Jazz
+
+Content goes here

data/spec/fixtures/content/pages/ledzep.mdown

@@ -0,0 +1,6 @@
+date: 29 December 2008
+categories: rock, funk, blues, heavy, folk
+
+#  Led Zeppelin
+
+Content goes here

data/spec/fixtures/content/pages/pentangle.mdown

@@ -0,0 +1,6 @@
+date: 29 December 2008
+categories: folk
+
+#  Pentangle
+
+Content goes here

data/spec/fixtures/content/pages/rare-earth.mdown

@@ -0,0 +1,6 @@
+date: 29 December 2008
+categories: funk, rock
+
+#  Rare Earth
+
+Content goes here

data/spec/fixtures/content/pages/rock.mdown

@@ -0,0 +1,5 @@
+
+
+#  Rock
+
+Content goes here

data/spec/fixtures/content/pages/the-meters.mdown

@@ -0,0 +1,6 @@
+date: 29 December 2008
+categories: funk
+
+#  The Meters
+
+Content goes here

data/spec/related_articles_spec.rb

@@ -0,0 +1,63 @@
+require 'nesta/app'
+
+require_relative '../lib/nesta-plugin-related-by-category/init'
+require_relative 'spec_helper'
+
+require 'minitest/spec'
+require 'minitest/autorun'
+require 'mocha/setup'
+
+describe "tests for finding related articles through an article's categories" do
+  include Nesta::Plugin::RelatedByCategory::Helpers
+  include ConfigSpecHelper
+
+  before do
+    stub_configuration
+  end
+
+  describe "setting up data from fixtures" do
+    it "fetches the fixure content path" do
+      Nesta::Config.content_path.must_equal 'fixtures/content'
+    end
+
+    it "instantiates articles correctly" do
+      ledzep = Nesta::Page.find_by_path('ledzep')
+      ledzep.heading.must_equal 'Led Zeppelin'
+      ledzep.categories.count.must_equal 5
+    end
+
+    it "instantiates categories correctly" do
+      rock = Nesta::Page.find_by_path('rock')
+      rock.heading.must_equal 'Rock'
+      rock.articles.count.must_equal 4
+      headings = rock.articles.map { |a| a.heading }
+      headings.must_equal ["Cream", "Jimi Hendrix", "Led Zeppelin", "Rare Earth"]
+    end
+  end
+
+  describe "finding related articles" do
+    before do
+      @ledzep = Nesta::Page.find_by_path('ledzep')
+      @bach = Nesta::Page.find_by_path('bach')
+    end
+
+    it "tests whether a page has related articles" do
+      has_related_articles?(@ledzep).must_equal true
+      has_related_articles?(@bach).must_equal false
+    end
+
+    it "finds related articles bound by a number (default parammeter)" do
+      related_to_ledzep = related_by_category(@ledzep)
+      related_to_ledzep.count.must_equal 3
+      headings = related_to_ledzep.map { |article| article.heading }
+      headings.must_equal ["Cream", "Jimi Hendrix", "Rare Earth"]
+    end
+
+    it "finds related articles bound by a number (specified parammeter)" do
+      related_to_ledzep = related_by_category(@ledzep, 10)
+      related_to_ledzep.count.must_equal 5
+      headings = related_to_ledzep.map { |article| article.heading }
+      headings.must_equal ["Cream", "Jimi Hendrix", "Rare Earth", "Pentangle", "The Meters"]
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,35 @@
+#This is a slimmed-down version of Graham's spec_helper, used for Nesta's own tests:
+#https://github.com/gma/nesta/blob/master/spec/spec_helper.rb
+#Mocha and MiniTest have replaced RSpec.
+
+module Nesta
+  class App < Sinatra::Base
+    set :environment, :test
+    set :reload_templates, true
+  end
+end
+
+module ConfigSpecHelper
+  def stub_yaml_config
+    @config = {}
+    Nesta::Config.stubs(:yaml_exists?).returns true
+    Nesta::Config.stubs(:yaml_conf).returns @config
+  end
+
+  def stub_config_key(key, value, options = {})
+    stub_yaml_config unless @config
+    if options[:rack_env]
+      @config['test'] ||= {}
+      @config['test'][key] = value
+    else
+      @config[key] = value
+    end
+  end
+
+  def stub_configuration(options = {})
+    stub_config_key('title', 'My blog', options)
+    stub_config_key('subtitle', 'about stuff', options)
+    stub_config_key(
+        'content', 'fixtures/content', options.merge(:rack_env => true))
+  end
+end

metadata

@@ -0,0 +1,114 @@
+--- !ruby/object:Gem::Specification
+name: nesta-plugin-related-by-category
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- James Abbott
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-03-23 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: nesta
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 0.9.11
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 0.9.11
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: A plugin that finds related articles to a Nesta article, based on the
+  relationship between its categories and other articles.
+email:
+- abbottjam@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/nesta-plugin-related-by-category.rb
+- lib/nesta-plugin-related-by-category/init.rb
+- lib/nesta-plugin-related-by-category/version.rb
+- nesta-plugin-related-by-category.gemspec
+- spec/fixtures/content/pages/bach.mdown
+- spec/fixtures/content/pages/blues.mdown
+- spec/fixtures/content/pages/classical.mdown
+- spec/fixtures/content/pages/cream.mdown
+- spec/fixtures/content/pages/folk.mdown
+- spec/fixtures/content/pages/funk.mdown
+- spec/fixtures/content/pages/heavy.mdown
+- spec/fixtures/content/pages/hendrix.mdown
+- spec/fixtures/content/pages/jazz.mdown
+- spec/fixtures/content/pages/ledzep.mdown
+- spec/fixtures/content/pages/pentangle.mdown
+- spec/fixtures/content/pages/rare-earth.mdown
+- spec/fixtures/content/pages/rock.mdown
+- spec/fixtures/content/pages/the-meters.mdown
+- spec/related_articles_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/abbottjam/nesta-plugin-related-by-category
+licenses: []
+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.0.3
+signing_key: 
+specification_version: 4
+summary: A plugin that finds related articles to a Nesta article, based on the relationship
+  between its categories and other articles.
+test_files:
+- spec/fixtures/content/pages/bach.mdown
+- spec/fixtures/content/pages/blues.mdown
+- spec/fixtures/content/pages/classical.mdown
+- spec/fixtures/content/pages/cream.mdown
+- spec/fixtures/content/pages/folk.mdown
+- spec/fixtures/content/pages/funk.mdown
+- spec/fixtures/content/pages/heavy.mdown
+- spec/fixtures/content/pages/hendrix.mdown
+- spec/fixtures/content/pages/jazz.mdown
+- spec/fixtures/content/pages/ledzep.mdown
+- spec/fixtures/content/pages/pentangle.mdown
+- spec/fixtures/content/pages/rare-earth.mdown
+- spec/fixtures/content/pages/rock.mdown
+- spec/fixtures/content/pages/the-meters.mdown
+- spec/related_articles_spec.rb
+- spec/spec_helper.rb