class SycLink::Designer

add_link(url, args = {}) click to toggle source

Adds a link based on the provided arguments to the website

# File lib/syclink/designer.rb, line 27
def add_link(url, args = {})
  website.add_link(Link.new(url, args))
end

add_links_from_file(file) click to toggle source

Reads arguments from a CSV file and creates links accordingly. The links are added to the websie

# File lib/syclink/designer.rb, line 33
def add_links_from_file(file)
  File.foreach(file) do |line|
    next if line.chomp.empty?
    url, name, description, tag = line.chomp.split(';')
    website.add_link(Link.new(url, { name: name,
                                     description: description,
                                     tag: tag }))
  end
end

create_website(directory, template_filename) click to toggle source

Creates the html representation of the website. The website is saved to the directory with websites title and needs an erb-template where the links are integrated to. An example template can be found at templates/syclink.html.erb

# File lib/syclink/designer.rb, line 152
def create_website(directory, template_filename)
  template = File.read(template_filename)
  File.open(html_file(directory, website.title), 'w') do |f|
    f.puts website.to_html(template)
  end 
end

delete_website(directory) click to toggle source

Deletes the website if it already exists

# File lib/syclink/designer.rb, line 142
def delete_website(directory)
  if File.exists? yaml_file(directory, website.title)
    FileUtils.rm(yaml_file(directory, website.title)) 
  end
end

export(format) click to toggle source

Export links to specified format

# File lib/syclink/designer.rb, line 51
def export(format)
  message = "to_#{format.downcase}"
  if website.respond_to? message
    website.send(message)
  else
    raise "cannot export to #{format}"
  end
end

find_links(search) click to toggle source

Finds links based on a search string

# File lib/syclink/designer.rb, line 66
def find_links(search)
  website.find_links(search)
end

import_links(importer) click to toggle source

Accepts and SycLink::Importer to import Links and add them to the website

# File lib/syclink/designer.rb, line 44
def import_links(importer)
  importer.links.each do |link|
    website.add_link(link)
  end
end

list_links(args = {}) click to toggle source

List links contained in the website and optionally filter on attributes

# File lib/syclink/designer.rb, line 61
def list_links(args = {})
  website.list_links(args)
end

load_website(website) click to toggle source

Loads a website based on the provided YAML-file and asigns it to the designer to operate on

# File lib/syclink/designer.rb, line 137
def load_website(website)
  @website = YAML.load_file(website)
end

merge_links() click to toggle source

Merge links with same URL

# File lib/syclink/designer.rb, line 108
def merge_links
  website.merge_links_on(:url)
end

new_website(title = "SYC LINK") click to toggle source

Creates a new website where designer can operate on

# File lib/syclink/designer.rb, line 22
def new_website(title = "SYC LINK")
  @website = Website.new(title)
end

remove_links(urls) click to toggle source

Deletes one or more links from the website. Returns the deleted links. Expects the links provided in an array

# File lib/syclink/designer.rb, line 114
def remove_links(urls)
  urls.map { |url| list_links({ url: url }) }.flatten.compact.each do |link|
    website.remove_link(link)
  end
end

remove_links_from_file(file) click to toggle source

Deletes links based on URLs that are provided in a file. Each URL has to be in one line

# File lib/syclink/designer.rb, line 122
def remove_links_from_file(file)
  urls = File.foreach(file).map { |url| url.chomp unless url.empty? }
  remove_links(urls)
end

report_links_availability(opts) click to toggle source

Check links availability. Takes a filter which values to return and whether to return available, unavailable or available and unavailable links. In the following example only unavailable links' url and response would be returned

report_links_availability(available: false, 
                          unavailable: false,
                          columns: "url,response")

# File lib/syclink/designer.rb, line 77
def report_links_availability(opts)
  cols = opts[:columns].gsub(/ /, "").split(',')
  website.report_links_availability.map do |url, response|
    result = if response == "200" and opts[:available]
               { "url" => url, "response" => response }
             elsif response != "200" and opts[:unavailable]
               { "url" => url, "response" => response }
             end
    next if result.nil?
    cols.inject([]) { |res, c| res << result[c.downcase] }
  end.compact
end

save_website(directory) click to toggle source

Saves the website to the specified directory with the downcased name of the website and the extension 'website'. The website is save as YAML

# File lib/syclink/designer.rb, line 129
def save_website(directory)
  File.open(yaml_file(directory, website.title), 'w') do |f|
    YAML.dump(website, f)
  end
end

update_link(url, args) click to toggle source

Updates a link. The link is identified by the URL. If there is more than one link with the same URL, only the first link is updated

# File lib/syclink/designer.rb, line 92
def update_link(url, args)
  website.find_links(url).first.update(args)
end

update_links_from_file(file) click to toggle source

Updates links read from a file

# File lib/syclink/designer.rb, line 97
def update_links_from_file(file)
  File.foreach(file) do |line|
    next if line.chomp.empty?
    url, name, description, tag = line.chomp.split(';')
    website.find_links(url).first.update({ name:        name,
                                           description: description,
                                           tag:         tag })
  end
end

Attributes

Public Instance Methods