syclink 0.0.1

data/lib/syclink/formatter.rb

@@ -0,0 +1,70 @@
+# Module that creates a link list and generates an html representation
+module SycLink
+
+  # Methods to print data in a formatted way
+  module Formatter
+
+    # Based on the rows provided and the header values a table is printed
+    def table(rows, header)
+      columns = extract_columns(rows, header)
+      widths  = max_column_widths(columns, header)
+      formatter = formatter_string(widths, " | ")
+      print_header(header, formatter)
+      print_horizontal_line("-", "-+-", widths)
+      print_table(columns, formatter)
+    end
+
+    # Extracts the columns to display in the table based on the header column
+    # names
+    def extract_columns(rows, header)
+      columns = []
+      header.each do |h|
+        columns << rows.map do |r|
+          r.send(h)
+        end  
+      end
+      columns
+    end
+
+    # Determines max column widths for each column based on the data and header
+    # columns
+    def max_column_widths(columns, header)
+      row_column_widths = columns.map do |c| 
+        c.reduce(0) { |m, v| [m, v.length].max }
+      end
+
+      header_column_widths = header.map { |h| h.length }
+
+      row_column_widths.zip(header_column_widths).map do |column|
+        column.reduce(0) { |m, v| [m, v].max }
+      end
+    end
+
+    # Creates a formatter string based on the widths and the column separator
+    def formatter_string(widhts, separator)
+      widhts.map do |width|
+        "%-#{width}s"
+      end.join(separator)
+    end
+
+    # Prints the table's header
+    def print_header(header, formatter)
+      puts cut(sprintf(formatter, *header), 80)
+    end
+
+    # Prints a horizontal line below the header
+    def print_horizontal_line(line, separator, widths)
+      puts cut(widths.map { |width| line * width }.join(separator), 80)
+    end
+
+    # Prints columns in a table format
+    def print_table(columns, formatter)
+      columns.transpose.each { |row| puts cut(sprintf(formatter, *row), 80) }
+    end
+
+    # Cuts the string down to the specified size
+    def cut(string, size)
+      string[0..size-1]
+    end
+  end
+end

data/lib/syclink/infrastructure.rb

@@ -0,0 +1,44 @@
+# Module that creates a link list and generates an html representation
+module SycLink
+
+  # Helper methods to setup the infrastructure for syclink
+  module Infrastructure
+
+    # Creates a directory if it does not exist
+    def create_directory_if_missing(directory)
+      unless File.exists? directory
+        Dir.mkdir directory
+      end
+    end
+
+    # Copies a file to a target directory
+    def copy_file_if_missing(file, to_directory)
+      unless File.exists? File.join(to_directory, File.basename(file))
+        FileUtils.cp(file, to_directory)
+      end
+    end
+
+    # Loads the configuration from a file
+    def load_config(file)
+      unless File.exists? file
+        File.open(file, 'w') do |f| 
+          YAML.dump({ default_website: 'default' }, f) 
+        end
+      end
+      YAML.load_file(file)
+    end
+
+    # Creates the filename of the website for saving, loading and deleting
+    def yaml_file(directory = '.', website)
+      File.join(directory, "#{website.downcase.gsub(/\s/, '-')}.website")
+    end
+    
+    # Creates an html filename to save the html representation of the website
+    # to
+    def html_file(directory = '.', website)
+      File.join(directory, "#{website.downcase.gsub(/\s/, '-')}.html")
+    end
+
+  end
+
+end

data/lib/syclink/link.rb

@@ -0,0 +1,62 @@
+# Module that creates a link list and generates an html representation
+module SycLink
+
+  # Creates a link with url, name, description and tag
+  class Link
+
+    # Attributes that are accessible
+    ATTRS = [:url, :name, :description, :tag]
+
+    # Attribute accessors generated from ATTRS
+    attr_accessor *ATTRS
+
+    # Create a new link with url and params. If params are not provided 
+    # defaults are used for name the url is used, description is empty and
+    # tag is set to 'untagged'
+    def initialize(url, params = {})
+      @url         = url
+      params       = defaults(url).merge(select_defined(params))
+      @name        = params[:name]
+      @description = params[:description]
+      @tag         = params[:tag]
+    end
+
+    # Updates the attributes of the link specified by args
+    def update(args)
+      select_defined(args).each do |attribute, value|
+        send("#{attribute}=", value)
+      end
+    end
+
+    # Checks whether the link matches the values provided by args and returns
+    # true if so otherwise false
+    def match?(args)
+      select_defined(args).reduce(true) do |sum, attribute|
+        sum = sum && (send(attribute[0]) == attribute[1])
+      end 
+    end
+
+    # Checks whether the search string is contained in one or more of the
+    # attributes. If the search string is found true is returned otherwise
+    # false
+    def contains?(search)
+      search = search.delete(' ')
+      target = instance_variables.map { |v| instance_variable_get v }.join
+      target.downcase.delete(' ').scan(search).size > 0
+    end
+
+    private
+
+    # Specifies the default values
+    def defaults(url)
+      { name: url, description: "", tag: "untagged" }
+    end
+
+    # Based on the ATTRS the args are returned that are included in the ATTRS.
+    # args with nil values are omitted
+    def select_defined(args)
+      args.select { |k, v| (ATTRS.include? k) && !v.nil? }
+    end
+  end
+
+end

data/lib/syclink/version.rb

@@ -0,0 +1,7 @@
+# Module that creates a link list and generates an html representation
+module SycLink
+
+  # Version of the application
+  VERSION = '0.0.1'
+
+end

data/lib/syclink/website.rb

@@ -0,0 +1,62 @@
+require_relative 'exporter'
+
+# Module that creates a link list and generates an html representation
+module SycLink
+  
+
+  # A Website is organizing a link list. The links can be added, updated and 
+  # removed. It is also possible to search for links. And finally an html 
+  # representation of the Website can be created.
+  class Website
+
+    include Exporter
+
+    # The links of the website
+    attr_reader :links
+    # The title of the website
+    attr_reader :title
+
+    # Create a new Website
+    def initialize(title = "Link List")
+      @links = []
+      @title = title
+    end
+
+    # Add a link to the website
+    def add_link(link)
+      links << link
+    end
+
+    # Remove a link from the website
+    def remove_link(link)
+      links.delete(link)
+    end
+
+    # List links that match the attributes
+    def list_links(args = {})
+      if args.empty?
+        links
+      else
+        links.select { |link| link.match? args }
+      end
+    end
+
+    # Finds all links that contain the search string
+    def find_links(search)
+      links.select { |link| link.contains? search }
+    end
+
+    # Groups the links on the provided attribute
+    def links_group_by(attribute)
+      links.map      { |link| { key: link.send(attribute), link: link } }
+           .group_by { |entry| entry[:key] }
+           .each     { |key, link| link.map! { |l| l[:link] }}
+    end
+
+    # List all attributes of the links
+    def link_attribute_list(attribute)
+      links.map { |link| link.send(attribute) }.uniq.sort
+    end
+  end
+
+end

data/lib/syclink/website_example.rb

@@ -0,0 +1,68 @@
+require_relative 'website'
+require_relative 'link'
+
+# Module that creates a link list and generates an html representation
+module SycLink
+
+  website = SycLink::Website.new("Test")
+  links = [ [ "http://sugaryourcoffee.de", 
+              {title: "Sugar Your Coffee", tag: "Home"}],
+            [ "https://github.com", 
+              {title: "Github", description: "Repository", tag: "Development"}],
+             [ "https://github.com", 
+              {title: "Github", description: "Repository", tag: "Learning"}],
+             [ "https://github.com", 
+              {title: "Github", description: "Repository", tag: "Development"}],
+             [ "https://github.com", 
+              {title: "Github", description: "Repository", tag: "Learning"}],
+             [ "https://github.com", 
+              {title: "Github", description: "Repository", tag: "Development"}],
+             [ "https://github.com", 
+              {title: "Github", description: "Repository", tag: "Development"}],
+             [ "https://github.com", 
+              {title: "Github", description: "Repository", tag: "Development"}],
+             [ "https://github.com", 
+              {title: "Github", description: "Repository", tag: "Learning"}],
+             [ "https://github.com", 
+              {title: "Github", description: "Repository", tag: "Fun"}],
+             [ "https://github.com", 
+              {title: "Github", description: "Repository", tag: "Development"}],
+             [ "https://github.com", 
+              {title: "Github", description: "Repository", tag: "Fun"}],
+             [ "https://github.com", 
+              {title: "Github", description: "Repository", tag: "Development"}],
+             [ "https://github.com", 
+              {title: "Github", description: "Repository", tag: "Development"}],
+             [ "https://github.com", 
+              {title: "Github", description: "Repository", tag: "Development"}],
+             [ "https://github.com", 
+              {title: "Github", description: "Repository", tag: "Development"}],
+             [ "https://github.com", 
+              {title: "Github", description: "Repository", tag: "Challenge"}],
+             [ "https://github.com", 
+              {title: "Github", description: "Repository", tag: "Challenge"}],
+             [ "https://github.com", 
+              {title: "Github", description: "Repository", tag: "Development"}],
+             [ "https://github.com", 
+              {title: "Github", description: "Repository", tag: "Challenge"}],
+             [ "https://github.com", 
+              {title: "Github", description: "Repository", tag: "Development"}],
+             [ "https://github.com", 
+              {title: "Github", description: "Repository", tag: "Development"}],
+             [ "https://github.com", 
+              {title: "Github", description: "Repository", tag: "Development"}],
+            [ "http://syc.dyndns.org:8080", 
+              {title: "Secondhand", description: "Selling", tag: "Home"}],
+            [ "http://syc.dyndns.org:8081", 
+              {title: "apptrack - application tracking", 
+               description: "Application tracking made so easy that is even \
+               unbelivable to make it more easy peasy as it is today", 
+               tag: "Home"}]]
+
+
+  links.each do |link| 
+    website.add_link(SycLink::Link.new(link[0], link[1]))
+  end
+
+  puts website.to_html(File.read("./templates/syclink.html.erb"))
+end

data/lib/syclink.rb

@@ -0,0 +1,7 @@
+require 'syclink/designer'
+require 'syclink/link'
+require 'syclink/exporter'
+require 'syclink/website'
+require 'syclink/infrastructure'
+require 'syclink/formatter'
+

data/setup.md

@@ -0,0 +1,92 @@
+Create Directory Structure
+==========================
+We follow the _RubyGems_ convention to organize a Ruby project. We create a
+directory structure as follows.
+
+````
+syclink
+ |
+ |--LICENSE
+ |--README.md
+ |--bin
+ |   |--command-line-file-goes-here
+ |--lib
+ |   |-syclink
+ |      |--application-files-go-here
+ |
+ |--spec
+ |   |--syclink
+ |       |--test-files-go-here
+ |--templates
+ |   |--syclink.html.erb
+ |   |--stylesheets
+ |       |--style.css.scss
+ |       |--style.css
+ |--.rspec
+ |--.gitignore
+````
+
+Organize the  source code with Git
+=================================
+To organize our source we use _Git_ and have to do an initialize like so
+
+    $ git init
+
+Then we have to create a repository at [Github](https://github.com) and push
+our project to _Github_
+
+    $ git commit -m "first commit"
+    $ git remote add origin git@github.com:sugaryourcoffee/syclink.git
+    $ git push -u origin master
+
+Create addtional basic files
+============================
+We should add a README to describe our application and decide upon a license
+we want to distribute it. We will use the [MIT License](http://opensource.org/licenses/MIT). 
+Also a _.gitignore_ file should be created to exclude i.e. temp-files from the 
+repository.
+
+Select the Ruby version
+=======================
+For a new project we want to use the newst Ruby version. At this writing it is
+verison 2.2.1. Suppose we use [RVM](https://rvm.io/). If not already installed
+we install it with
+
+    $ gpg --keyserver hkp://keys.gnupg.net --recv-keys 409B6B1796C275462A1703113804BB82D39DC0E3
+    $ \curl -sSL https://get.rvm.io | bash -s stable
+    $ rvm install 2.2.1
+    $ rvm use 2.2.1
+
+Install RSpec
+=============
+For tests we want to use _RSpec_. To install RSpec issue this command
+
+    $ gem install rspec
+
+This will install the latest version. To see results of RSpec in color add
+following line to _.rspec_ in the application's root directory
+
+    --color
+
+Install Sass
+============
+As we will create a html file with links we need to style with CSS. But instead
+of using plain CSS we will use Scss. For that we need to install Sass
+
+    $ gem install sass
+
+Then we can write stylesheets in the sassy style and when done compile them
+to CSS with
+
+    $ sass templates/stylesheets/style.scss:templates/stylesheets/style.css
+
+Distribution
+============
+To distribute the application we need the Gemfile and a Rakefile with the
+'rubygems/package\_task'.
+
+From the command line we call
+
+    $ rake package
+
+This will create a gem package we can distribute

data/spec/syclink/designer_spec.rb

@@ -0,0 +1,100 @@
+require 'syclink/designer.rb'
+
+module SycLink
+
+  describe Designer do
+
+    before do 
+      @designer = Designer.new
+      @designer.new_website("Test Site")
+    end
+
+    it "should add a link" do
+      @designer.add_link("http://example.com",
+                         { name: "Example",
+                           description: "An example website",
+                           tag: "Test"  })
+
+      expect(@designer.website.links.size).to eq 1
+    end
+
+    it "should add links from a file" do
+      links = [ "http://example.com;Example;An example website;Test",
+                "http://test.de;A test website;Test",
+                "http://challenge.org;A challenge website;Challenge" ]
+      File.write("links.tmp", links.join("\n"))
+
+      @designer.add_links_from_file("links.tmp")
+      expect(@designer.website.links.size).to eq 3
+
+      FileUtils.rm("links.tmp")
+    end
+
+    it "should find a link" do
+      @designer.add_link("http://example.com",
+                         { name: "Example",
+                           description: "An example website",
+                           tag: "Test" })
+      expect(@designer.find_links("http://example.com")).to be_truthy
+    end
+
+    it "should update a link" do
+      @designer.add_link("http://example.com",
+                         { name: "Example",
+                           description: "An example website",
+                           tag: "Test" })
+      @designer.update_link("http://example.com",
+                            { name: "Reality",
+                              description: "A reality website",
+                              tag: "Reality" })
+
+      expect(@designer.find_links("http://example.com")
+                      .first.name).to eq "Reality"
+    end
+
+    it "should list all links" do
+      @designer.add_link("http://example.com",
+                         { name: "Example",
+                           description: "An example website",
+                           tag: "Test" })
+
+      expect(@designer.list_links).to eq @designer.website.links
+    end
+
+    it "should list links based on attributes" do
+      @designer.add_link("http://example.com",
+                         { name: "Example",
+                           description: "An example website",
+                           tag: "Test" })
+      @designer.add_link("http://example.com",
+                         { name: "Reality",
+                           description: "A reality website",
+                           tag: "Reality" })
+
+      expect(@designer.list_links({name: "Reality"}).size).to eq 1
+    end
+
+    it "should delete a link" do
+      @designer.add_link("http://example.com",
+                         { tag: "Example", name: "Link" })
+      @designer.add_link("http://reality.com",
+                         { tag: "Reality", name: "URL" })
+       
+      expect(@designer.list_links.size).to eq 2
+      @designer.remove_links(["http://reality.com"])
+      expect(@designer.list_links.size).to eq 1
+    end
+
+    it "should save, load and delete a website" do
+      @designer.add_link("http://example.com",
+                         { tag: "Loader" })
+      @designer.save_website(".")
+      @designer.load_website("test-site.website")
+      expect(@designer.website.title).to eq "Test Site"
+      @designer.delete_website(".")
+      expect(Dir["./website.website"]).to be_empty
+    end
+
+  end
+
+end

data/spec/syclink/link_spec.rb

@@ -0,0 +1,47 @@
+require 'syclink/link'
+
+module SycLink
+
+  describe Link do
+
+    before do 
+      @link = Link.new("http://example.com")
+      @link_complete = Link.new("http://example.com", 
+                                { name:        "Example",
+                                  description: "For testing purposes",
+                                  tag:         "Test" })
+    end
+
+    it "should create a link" do
+      expect(@link.url).to eq "http://example.com"
+      expect(@link.name).to eq "http://example.com"
+      expect(@link.description).to be_empty
+      expect(@link.tag).to eq "untagged"
+    end
+
+    it "should update a link" do
+      @link.update({name:       "Example",
+                   description: "For testing purposes",
+                   tag:         "Test"})
+      expect(@link.name).to        eq "Example"
+      expect(@link.description).to eq "For testing purposes"
+      expect(@link.tag).to         eq "Test"
+    end
+
+    it "should return true if search attributes match" do
+      expect(@link_complete.match?({url: "http://example.com"})).to be_truthy
+      expect(@link_complete.match?({url: "http://example.de"})).to  be_falsey
+      expect(@link_complete.match?({url: "http://example.com",
+                                    name: "Example"})).to           be_truthy
+      expect(@link_complete.match?({description: "For testing purposes",
+                                    tag:         "Test"})).to       be_truthy
+      expect(@link_complete.match?({tag: "Test"})).to               be_truthy
+    end
+
+    it "should return true if search string is part of link attributes" do
+      expect(@link_complete.contains?("example.com")).to be_truthy
+      expect(@link_complete.contains?("nothing")).to     be_falsey
+    end
+  end
+
+end

data/spec/syclink/website_spec.rb

@@ -0,0 +1,75 @@
+require 'syclink/website'
+
+module SycLink
+
+  describe Website do
+    
+    before do
+      @link = Link.new("http://example.com",
+                       { name:       "Example",
+                         description: "An example website",
+                         tag:         "Test" })
+      @website = Website.new("Link List")
+      @template = <<-HERE.gsub(/^ {8}/, '')
+        <html>
+          <h1><%= title %></h1>
+          <% links.each do |link| %>
+            <a href='<%= link.url %>'><%= link.name %></a>
+            <%= link.description %> <%= link.tag %>
+          <% end %>
+        </html> 
+      HERE
+    end
+
+    it "should add link" do
+      expect(@website.links).to eq []
+      @website.add_link(@link)
+      expect(@website.links).to eq [@link]
+    end
+
+    it "should delete link" do
+      @website.add_link(@link)
+      @website.remove_link(@link)
+      expect(@website.links).to eq []
+    end
+
+    it "should list links based on attributes" do
+      @website.add_link(@link)
+      expect(@website.list_links({name: "not there"}).size).to eq 0
+      expect(@website.list_links({name: "Example"}).size).to   eq 1
+      expect(@website.list_links.size).to                       eq 1
+    end
+
+    it "should find links based on search string" do
+      @website.add_link(@link)
+      expect(@website.find_links("example.com")).to eq [@link]
+      expect(@website.find_links("website")).to     eq [@link]
+      expect(@website.find_links("nothing")).to     eq []
+    end
+
+    it "should create the html representation" do
+      @website.add_link(@link)
+      html = @website.to_html(@template)
+      expect(html).to include("<a href='http://example.com'>")
+      expect(html).to include("Example")
+      expect(html).to include("An example website")
+      expect(html).to include("Test")
+    end
+
+    it "should group links on tags" do
+      @website.add_link(@link)
+      @website.add_link(@link)
+      target = { "Test" => [@link, @link] }
+      expect(@website.links_group_by(:tag)).to eq target
+    end
+
+    it "should list all tags" do
+      @website.add_link(@link)
+      @website.add_link(@link)
+      target = [ @link.tag ]
+      expect(@website.link_attribute_list(:tag)).to eq target
+    end
+
+  end
+
+end

data/syclink.gemspec

@@ -0,0 +1,23 @@
+# Ensure we require the local version and not one we might have installed already
+require File.join([File.dirname(__FILE__),'lib','syclink','version.rb'])
+spec = Gem::Specification.new do |s| 
+  s.name = 'syclink'
+  s.version = SycLink::VERSION
+  s.author = 'Pierre Sugar'
+  s.email = 'pierre@sugaryourcoffee.de'
+  s.homepage = 'https://github.com/sugaryourcoffee/syclink'
+  s.platform = Gem::Platform::RUBY
+  s.summary = 'A link list html generator'
+  s.description = 'Create a link list and display it in a HTML file'
+  s.license = 'MIT license (MIT)'
+  s.files = `git ls-files`.split(" ")
+  s.require_paths << 'lib'
+  s.has_rdoc = true
+  s.extra_rdoc_files = ['README.rdoc','syclink.rdoc']
+  s.rdoc_options << '--title' << 'test' << '--main' << 'README.rdoc' << '-ri'
+  s.bindir = 'bin'
+  s.executables << 'syclink'
+  s.add_development_dependency('rspec', '3.3.1')
+  s.add_development_dependency('sass', '3.4.15')
+  s.add_runtime_dependency('gli','2.13.1')
+end