newsletter 3.0.2 → 3.2.0

data/app/models/newsletter/asset.rb

@@ -27,5 +27,11 @@ module Newsletter
     def self.build_public_dirname(id)
       "#{::Newsletter.asset_path}/#{("%08d" %id)[-8,4]}/#{("%08d" %id)[-4,4]}"
     end
+
+    def is_image?
+      image.content_type.include?('image')
+    rescue => e
+      false
+    end
   end
-end
+end

data/app/models/newsletter/design.rb

@@ -21,7 +21,7 @@ module ::Newsletter
 
     scope :active, :conditions => {:deleted_at => nil}
   
-    validates_presence_of :name
+    validates :name, presence: true, uniqueness: true
 
     # attr_protected :id
     #FIXME: make this work with deletable or convert to auditable, and extend it to access destroyed records
@@ -37,7 +37,8 @@ module ::Newsletter
           :html_text => html_text,
           :description => description,
           :areas => areas.collect{|area| area.export_fields}, 
-          :elements => elements.collect{|element| element.export_fields}
+          :elements => elements.collect{|element| element.export_fields},
+          :images => base64_encoded_images
         },file)
       end
     end
@@ -52,7 +53,7 @@ module ::Newsletter
       design = nil
       transaction do 
         data[:name] = design_name if design_name
-        design = Design.create!(:name => data[:name], 
+        design = Design.create(:name => data[:name], 
           :html_text => data[:html_text],
           :description => data[:description])
         data[:areas].each do |area_data|
@@ -61,21 +62,59 @@ module ::Newsletter
         data[:elements].each do |element_data|
           Element.import(design,element_data)
         end
+        design.import_images(data[:images])
       end
+      raise "Error importing design: #{design.errors.full_messages.join("\n  ")}" unless design.valid?
       design
     end
 
     # returns path to newsletter design for use in views and is the same for actual file
     def view_path(this_name=nil)
-      "#{base_design_path(this_name)}/layout.html.erb"
+      File.join(base_design_path(this_name),'layout.html.erb')
     end
   
-    # 
+    # returns the path to the base of the design's files
     def base_design_path(this_name=nil)
-      "#{::Newsletter.designs_path}/designs/#{name_as_path(this_name)}"
+      File.join(::Newsletter.designs_path,'designs',name_as_path(this_name))
     end
-  
 
+    # returns the image filenames inside a design
+    def images
+      Dir.glob(File.join(images_path,'*.*')).map{|f| File.basename(f)} || []
+    rescue => e
+      []
+    end
+
+    # returns the images as an array of base64 encoded strings
+    def base64_encoded_images
+      images.map {|image| {
+        name: image,
+        data: Base64.encode64(File.binread(File.join(images_path,image)))
+      }}
+    end
+
+    # returns where a design's images should go, can override for 'old_name'
+    def images_path(the_name=nil)
+      the_name ||= name
+      File.join('public','images',name_as_path(the_name)) 
+    end
+
+    # move a design's images on name change
+    def move_images
+      return unless @old_name && @old_name != name
+      FileUtils.mv(images_path(@old_name),images_path)
+    end
+
+    # imports images from array of base64 encoded images
+    def import_images(image_imports)
+      image_imports ||= []
+      FileUtils.mkdir_p(images_path)
+      image_imports.each do |image|
+        File.binwrite(File.join(images_path,image[:name]),
+          Base64.decode64(image[:data])
+        )
+      end
+    end
 
     def html_text
       return @html_text if @html_text
@@ -86,20 +125,6 @@ module ::Newsletter
        @html_text = text
     end
   
-    # def area_attributes=(area_attributes)
-    #   area_attributes.each do |attributes|
-    #     if attributes[:id].blank?
-    #       Rails.logger.debug "Building Area : #{attributes.inspect}"
-    #       areas.build(attributes)
-    #     else
-    #       Rails.logger.debug "Setting Area data: #{attributes.inspect}"
-    #       area = areas.detect{|area| area.id == attributes[:id].to_i}
-    #       area.attributes = attributes
-    #     end
-    #   end
-    # end
-
-  
     def name=(new_name)
       return if self[:name].eql?(new_name)
       @old_name = self[:name] unless @old_name
@@ -121,6 +146,7 @@ module ::Newsletter
     end
   
     include Deleteable
+
     protected
     def read_design
       File.readlines(view_path).join
@@ -137,6 +163,7 @@ module ::Newsletter
     def move_design_on_name_change
       return unless @old_name and File.exists?(view_path(@old_name))
       FileUtils.mv(base_design_path(@old_name),base_design_path)
+      move_images(@old_name, name)
     end
 
     def write_design
@@ -145,18 +172,5 @@ module ::Newsletter
         file.write html_text
       end
     end
-  
-  
-    # def save_areas
-    #   areas.each do |area|
-    #     if area.should_destroy?
-    #       Rails.logger.debug "Destroying newsletter area: #{area.inspect}"
-    #       area.destroy
-    #     else
-    #       Rails.logger.debug "Saving newsletter area: #{area.inspect}"
-    #       area.save
-    #     end
-    #   end
-    # end
   end
 end

data/app/models/newsletter/element.rb

@@ -61,35 +61,6 @@ module Newsletter
       @html_text = text
     end
   
-    def update_attributes(params={})
-      transaction do 
-        super
-      end
-    end
-
-    def save_fields
-      return true unless @fields_attributes.present?
-      @fields_attributes.each_pair do |index,attributes|
-        should_destroy = ['true','1'].include?attributes.delete(:_destroy)
-        if attributes[:id].blank?
-          next if should_destroy
-          attributes.delete(:id)
-          klass = attributes.delete(:type)
-          fields << klass.constantize.new(attributes)
-        else
-          id = attributes.delete(:id).to_i
-          if should_destroy
-            fields.where(id: id).limit(1).each(&:destroy)
-          else
-            type = attributes.delete(:type)
-            field = fields.detect{|field| field.id == id}
-            field.update_attributes(attributes)
-            field = Field.morph(field,type) unless field.class.name.eql?(type)
-          end
-        end
-      end
-    end
-  
     # returns field data so that Newsletter::Design.export(instance) can export itself to a YAML file  
     def export_fields
       { :name => name,
@@ -121,7 +92,6 @@ module Newsletter
         move_design_on_name_change
         write_design
         super
-        save_fields
       end
     end
   
@@ -146,17 +116,5 @@ module Newsletter
       FileUtils.mv(file_path(@old_name),file_path)
     end
   
-    # def save_fields
-    #   Rails.logger.warn "Fields: #{fields.inspect}"
-    #   fields.each do |field|
-    #     if field.should_destroy?
-    #       Rails.logger.warn "Destroy Field: #{field.inspect}"
-    #       field.delete
-    #     else
-    #       Rails.logger.warn "Save Field: #{field.inspect}"
-    #       field.save!      
-    #     end
-    #   end
-    # end
   end
 end

data/app/models/newsletter/field.rb

@@ -15,6 +15,8 @@ module Newsletter
       has_many :field_values, :class_name => 'Newsletter::FieldValue'
       belongs_to :updated_by, :class_name => 'User'
 
+      acts_as_list :scope => :element, :column => :sequence
+
       validates_presence_of :name
 =begin
       FIXME: make this work with deletable or convert to auditable, and extend it to access destroyed records
@@ -25,9 +27,8 @@ module Newsletter
         ["name=? and element_id=? and id!=? and deleted_at is null", field.element_id,
         field.id]).nil? }
 =end
-      attr_accessor :should_destroy
-
-      attr_protected :id
+      attr_accessible :name, :type, :element_id, :label, :sequence, :is_required, 
+        :description, :updated_by
       
       include Deleteable
 
@@ -58,8 +59,9 @@ module Newsletter
       end
 
       # returns a pieces value for a given Newsletter::Field
-      def value_for_piece(piece)
-        get_value(piece).to_s.html_safe
+      def value_for_piece(piece,safe=true)
+        return get_value(piece).to_s.html_safe if safe
+        get_value(piece).to_s
       end
 
       # sets a pieces value for a Newsletter::Field
@@ -92,11 +94,6 @@ module Newsletter
         Field.find(field.id)
       end
 
-      # used in figuring out whether to destroy a field as we are editing fields inside an element form
-      def should_destroy?
-        should_destroy.to_i == 1
-      end
-
       # find the partial to display a form for creating a Newsletter::Piece
       def form_partial_path
          "newsletter/fields/#{type.to_s.gsub(/.*Newsletter::Field::/,'').gsub(/([^A-Z])([A-Z])/,'\\1_\\2').downcase}"

data/app/models/newsletter/field/inline_asset.rb

@@ -11,8 +11,6 @@ module Newsletter
     has_many :assets, :foreign_key => :field_id, 
       :class_name => 'Newsletter::Asset'
 
-    attr_protected :id
-
     # overridden from main class to choose between a Newsletter::Asset or a given URL
     def value_for_piece(piece)
       Value.new(:url => url_for_piece(piece), :text => get_value(piece,:text), :asset => asset(piece))
@@ -55,6 +53,21 @@ module Newsletter
     # fields
     class Value
       attr_accessor :url, :text, :asset, :asset_id
+      def is_image?
+        if asset.present?
+          asset.is_image?
+        else
+          is_image_by_extension?
+        end
+      end
+
+      def is_image_by_extension?
+        extension = File.extname(url).gsub(/^\./,'')
+        [ 'bmp', 'cod', 'gif', 'ief', 'jpe', 'jpeg', 'jpg', 'png',
+          'jfif', 'svg', 'tif', 'tiff'
+        ].include?(extension.downcase)
+      end
+
       def initialize(params)
         @url = params[:url]
         @text = params[:text]

data/app/models/newsletter/newsletter.rb

@@ -27,6 +27,7 @@ module Newsletter
 
     attr_protected :id
 
+    # returns any piece that is a headline
     def headlines
       pieces.select{|piece| piece.respond_to?(:headline)}
     end
@@ -52,6 +53,7 @@ module Newsletter
       end
     end
 
+    # whether or not the newsletter will show on the archives page
     def published?
       !published_at.nil?
     end
@@ -70,6 +72,10 @@ module Newsletter
     def public_url(mode='')
       "#{::Newsletter.site_url}/newsletters/#{self[:id]}#{mode.blank? ? '' : "/#{mode}"}"
     end
+
+    def image_uri(filename)
+      File.join(design.images_path.gsub(/.*public\//,'/'), filename)
+    end
   
     # used to generate the newsletter from a model or someplace other than the web stack
     #   FIXME: There has to be a better way, where railsy stuff works ... erb doesn't seem 
@@ -82,7 +88,7 @@ module Newsletter
       fetch(public_url(mode))
     end
 
-    # retrieve a newsletter area by name
+    # retrieve a newsletter area by name - for use in render/views
     def area(name)
       design.areas.by_name(name).first
     end
@@ -94,30 +100,31 @@ module Newsletter
       design.areas.each do |area|
         variables[area.name.to_sym] = area
       end
+      variables[:title] = self.name
       variables
     end
   
+    # :nodoc sets a pieces attributes coming from the form
+    # FIXME: this is probably covered by rails 3 accepts_attributes_for, but we 
+    # will change when we go to 4 anyways
     def piece_attributes=(piece_attributes)
       piece_attributes.each do |attributes|
         pieces.build(attributes)
       end
     end
   
+    # helper to get areas for newsletter
     def areas
       design.try(:areas).to_a
     end
-  
+    
+    # fetch a url and return the body
     def fetch(uri_str, limit = 10)
-      # You should choose better exception.
-      Rails.logger.debug "Fetching #{uri_str}"
-      raise ArgumentError, 'HTTP redirect too deep' if limit == 0
-
-      response = Net::HTTP.get_response(URI.parse(uri_str))
-      case response
-      when Net::HTTPSuccess     then response.body
-      when Net::HTTPRedirection then fetch(response['location'], limit - 1)
+      uri = URI.parse(uri_str)
+      if uri.scheme.eql?('file')
+        File.binread(uri_str.gsub(%r#^file://#,''))
       else
-        response.error!
+        uri.read
       end
     end
 

data/app/models/newsletter/piece.rb

@@ -1,5 +1,5 @@
 =begin rdoc
-Author::    Chris Hauboldt (mailto:biz@lnstar.com)
+Aduthor::    Chris Hauboldt (mailto:biz@lnstar.com)
 Copyright:: 2009 Lone Star Internet Inc.
 
 NewsletterPieces are the glue that tie data together to form a piece in an area of a design.
@@ -24,7 +24,10 @@ module Newsletter
 
     attr_accessor :field_values_attributes
 
+    #attr_accessible :field_values_attributes, :newsletter_id, :element_id, :area_id
     attr_protected :id
+
+    #validates_presence_of :newsletter, :element, :area, :field_values
     
     # returns locals to be used in its Newsletter::Element design
     def locals
@@ -32,51 +35,41 @@ module Newsletter
       @locals = Hash.new
       fields.each do |field|
         @locals[field.name.to_sym] = field.value_for_piece(self)
-        define_getter_for_locals(field.name.to_sym) unless respond_to?(field.name.to_sym)
       end
       @locals
     end
 
+    # returns a pieces fields
     def fields
       element.try(:fields).try(:uniq) || []
     end
 
-    def newsletter
-      return nil unless newsletter_id.present?
-      @newsletter ||= ::Newsletter::Newsletter.find(newsletter_id)
-    end
-    
     # used to save out a piece's fields, since they are inline in a piece's form  
     def field_values_attributes=(values)
       @field_values_attributes = values
     end
 
-    def set_field_values
-      return unless defined?(@field_values_attributes) && @field_values_attributes.present?
-      @field_values_attributes.each_pair do |field_id,key_value_pairs|
-        field = Field.find(field_id)
-        field.set_value_for_piece(self,key_value_pairs)
-      end
-    end
-
+    # whether it can respond to a 'method' in its locals hash
     def respond_to?(my_method,use_private=false)
       return true if super
       if locals.keys.include?(my_method.to_sym)
-        define_getter_for_locals(my_method)
         true
       else
         false
       end
     end
 
+    # respond for its named methods for its element's template
+    # these values will be in its locals hash
     def method_missing(*args)
       if args.length == 1 and locals.has_key?(args[0].to_sym)
-        define_getter_for_locals(args[0])
+        locals[args[0].to_sym]
       else
         super
       end
     end
 
+    # :nodoc override save for transaction to set its field values
     def save(*args)
       transaction do 
         set_field_values
@@ -84,13 +77,16 @@ module Newsletter
       end
     end  
 
-    private
-    def define_getter_for_locals(key)
-      class_eval %Q|
-      def #{key}
-        locals[:#{key}]
-      end|
-      eval key.to_s
+    protected
+
+    # sets the piece's field values after a save
+    def set_field_values
+      return unless defined?(@field_values_attributes) && @field_values_attributes.present?
+      @field_values_attributes.each_pair do |field_id,key_value_pairs|
+        field = Field.find(field_id)
+        field.set_value_for_piece(self,key_value_pairs)
+      end
     end
+
   end
 end